ogs_katacheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1aab2ad84305b247e1322ca044945c54f70b791018335241fad5dd84dd366334
+  data.tar.gz: d27f633ba9711c8919dbd31a3804894223d8abe580fe038b4fada757f0c74690
+SHA512:
+  metadata.gz: 319fb6ca517da68aa5b239df2d2549104f2e3908fdcc2c3e022d635806db2f1b0db7967494b623f43f8b25d86803718bcee0df27a1bf9996dd5889875963472f
+  data.tar.gz: af2912f11d6146ded07656e729540a565ad06313131b3442aa67a553cb968139447d2d56e1ac621270655c58f421ed17c0bb66682b88be3574cddb46d19feb3d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+### 0.1.0
+- Added ability to check games against OGS full reviews. 

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ogs_katacheck.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem 'faraday'
+# gem 'pry'

data/README.md

@@ -0,0 +1,37 @@
+# OGS KataCheck
+
+This CLI gem is intended to aid OGS team members in the investigation of suspected AI cheaters.
+
+It pulls game information from the OGS API and checks the user submitted moves against full reviews run on the game.
+
+## Installation
+
+You will need to have Ruby installed on your machine to run this CLI. If you are using a Mac, this is already done for you. If on a Windows machine you can install it by following [these instructions](https://stackify.com/install-ruby-on-windows-everything-you-need-to-get-going/).
+
+To install this Gem, open a terminal and run:
+
+    $ gem install ogs_katacheck
+
+## Usage
+
+After installing OGS KataCheck, you can run it by opening a terminal and typing:
+
+    $ ogs-katacheck
+
+You will be asked to enter a game ID. This can be simply copied and pasted from OGS.
+
+You will then be presented with a list of available OGS AI reviews. **Only full reviews** are useable with this tool.  If you do not see a full review in the list, open the game in OGS and run a full review. Once the server has completed the review, re-run the tool.
+
+The tool will output the number of user submitted moves that match the top 4 moves suggested by the AI in the review. Obviously, `tier 1` and `tier 2` moves are most important to look at, but the overall percentages can also be helpful.
+
+***Note:** A high percentage match in a game does not necessarily mean the user is cheating, but high percentage matches across many games will certainly warrant further investigation.*
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubymineshaft/ogs_katacheck.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ogs_katacheck"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/ogs-katacheck

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require './lib/ogs_katacheck'
+
+OGSKataCheck::CLI.new.call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ogs_katacheck.rb

@@ -0,0 +1,7 @@
+require 'pry'
+require 'faraday'
+require 'json'
+require_relative "./ogs_katacheck/version"
+require_relative "./ogs_katacheck/cli"
+require_relative "./ogs_katacheck/review"
+require_relative "./ogs_katacheck/full_review"

data/lib/ogs_katacheck/cli.rb

@@ -0,0 +1,58 @@
+class OGSKataCheck::CLI
+
+  def call
+    puts "Enter the Game ID you'd like to check for AI use:"
+
+    game_id = gets.strip
+    get_reviews(game_id)
+    show_review_menu(game_id)
+    check_id = gets.strip.to_i
+    check(check_id)
+    puts ""
+    puts "Check another game? (Y/N)"
+    input = gets.strip.downcase
+    if input == "y"
+      Review.destroy_all
+      FullReview.destroy_all
+      call
+    else
+      show_farewell
+    end
+  end
+
+  def get_reviews(game_id)
+    response = Faraday.get "https://online-go.com/api/v1/games/#{game_id}/ai_reviews"
+    data = JSON.parse(response.body)
+    data.each_with_index do |review, index|
+      Review.new(review, number: index + 1)
+    end
+
+  end
+
+  def show_review_menu(game_id)
+    puts ""
+    puts ""
+    puts "Game ID: #{game_id}"
+    puts ""
+    puts "The following reviews are available:"
+
+    Review.all.each do |review|
+      puts "#{review.number}.  #{review.id} - #{review.engine} - #{review.type} - #{review.date}"
+    end
+
+    puts ""
+    puts "Enter the number of a review to check:"
+
+  end
+
+  def check(check_id)
+    puts "Processing. Please wait..."
+    review = Review.find_by_number(check_id)
+    review.check
+  end
+
+  def show_farewell
+    puts "Goodbye!"
+  end
+
+end

data/lib/ogs_katacheck/full_review.rb

@@ -0,0 +1,70 @@
+class FullReview
+  attr_accessor :win_rates, :scores, :id, :type, :game_id, :engine, :engine_version, :network, :network_size, :date, :strength, :win_rate, :moves,
+    :total_moves, :black_tier_1, :black_tier_2, :black_tier_3, :black_tier_4, :white_tier_1, :white_tier_2, :white_tier_3, :white_tier_4, :black_total, :white_total
+
+  @@all = []
+
+  def initialize(attributes)
+    attributes.each {|key, value| self.send(("#{key}="), value)}
+    @black_tier_1 = [0, 0]
+    @black_tier_2 = [0, 0]
+    @black_tier_3 = [0, 0]
+    @black_tier_4 = [0, 0]
+    @black_total = [0, 0]
+    @white_total = [0, 0]
+    @white_tier_1 = [0, 0]
+    @white_tier_2 = [0, 0]
+    @white_tier_3 = [0, 0]
+    @white_tier_4 = [0, 0]
+
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.destroy_all
+    self.all.clear 
+  end
+
+  def calculate_percentages
+    @black_tier_1[1] = @black_tier_1[0].to_f / @total_moves / 2 * 100
+    @black_tier_2[1] = @black_tier_2[0].to_f / @total_moves / 2 * 100
+    @black_tier_3[1] = @black_tier_3[0].to_f / @total_moves / 2 * 100
+    @black_tier_4[1] = @black_tier_4[0].to_f / @total_moves / 2 * 100
+    @white_tier_1[1] = @white_tier_1[0].to_f / @total_moves / 2 * 100
+    @white_tier_2[1] = @white_tier_2[0].to_f / @total_moves / 2 * 100
+    @white_tier_3[1] = @white_tier_3[0].to_f / @total_moves / 2 * 100
+    @white_tier_4[1] = @white_tier_4[0].to_f / @total_moves / 2 * 100
+
+    @black_total[0] = @black_tier_1[0] + @black_tier_2[0] + @black_tier_3[0] + @black_tier_4[0]
+    @white_total[0] = @white_tier_1[0] + @white_tier_2[0] + @white_tier_3[0] + @white_tier_4[0]
+
+    @white_total[1] = @white_tier_1[1] + @white_tier_2[1] + @white_tier_3[1] + @white_tier_4[1]
+    @black_total[1] = @black_tier_1[1] + @black_tier_2[1] + @black_tier_3[1] + @black_tier_4[1]
+  end
+
+
+  def process
+    @total_moves = @moves.count;
+
+    @moves.each do |move|
+      current_move = move[1]["move_number"]
+      previous_move = @moves[(current_move.to_i - 1).to_s]
+      move_made = move[1]["move"]
+      if current_move.to_i >= 2
+        if previous_move["branches"][0]["moves"][0] == move_made
+          current_move % 2 == 0 ? @white_tier_1[0] += 1 : @black_tier_1[0] += 1
+        elsif previous_move["branches"].count >= 2 && previous_move["branches"][1]["moves"][0] == move_made
+          current_move % 2 == 0 ? @white_tier_2[0] += 1 : @black_tier_2[0] += 1
+        elsif previous_move["branches"].count >= 3 && previous_move["branches"][2]["moves"][0] == move_made
+          current_move % 2 == 0 ? @white_tier_3[0] += 1 : @black_tier_3[0] += 1
+        elsif previous_move["branches"].count >= 4 && previous_move["branches"][3]["moves"][0] == move_made
+          current_move % 2 == 0 ? @white_tier_4[0] += 1 : @black_tier_4[0] += 1
+        end
+      end
+    end
+    calculate_percentages
+  end
+end

data/lib/ogs_katacheck/review.rb

@@ -0,0 +1,49 @@
+class Review
+  attr_accessor :full_review, :number, :id, :type, :game_id, :engine, :engine_version, :network, :network_size, :date, :strength, :win_rate, :moves
+  @@all = []
+
+  def initialize(attributes, number:)
+    attributes.each {|key, value| self.send(("#{key}="), value)}
+    @number = number
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.destroy_all
+    self.all.clear
+  end
+
+  def self.find_by_number(number)
+    @@all.find{|review| review.number == number}
+  end
+
+  def check
+
+    puts "Checking player submitted moves against #{@engine} #{@type} review ##{@id}..."
+    review = load_review
+    review.process
+    puts ""
+    puts "-----------------------------------------------------"
+    puts "Black Tier 1 Moves: #{review.black_tier_1[0]} --- #{review.black_tier_1[1].round(2)}%"
+    puts "Black Tier 2 Moves: #{review.black_tier_2[0]} --- #{review.black_tier_2[1].round(2)}%"
+    puts "Black Tier 3 Moves: #{review.black_tier_3[0]} --- #{review.black_tier_3[1].round(2)}%"
+    puts "Black Tier 4 Moves: #{review.black_tier_4[0]} --- #{review.black_tier_4[1].round(2)}%"
+    puts "-----------------------------------------------------"
+    puts "White Tier 1 Moves: #{review.white_tier_1[0]} --- #{review.white_tier_1[1].round(2)}%"
+    puts "White Tier 2 Moves: #{review.white_tier_2[0]} --- #{review.white_tier_2[1].round(2)}%"
+    puts "White Tier 3 Moves: #{review.white_tier_3[0]} --- #{review.white_tier_3[1].round(2)}%"
+    puts "White Tier 4 Moves: #{review.white_tier_4[0]} --- #{review.white_tier_4[1].round(2)}%"
+    puts "-----------------------------------------------------"
+    puts "Black Total Top Moves: #{review.black_total[0]} --- #{review.black_total[1].round(2)}%"
+    puts "White Total Top Moves: #{review.white_total[0]} --- #{review.white_total[1].round(2)}%"
+    puts "-----------------------------------------------------"
+
+  end
+
+  def load_review
+    FullReview.new(JSON.parse(Faraday.get("https://online-go.com/termination-api/game/#{@game_id}/ai_review/#{@id}").body))
+  end
+end

data/lib/ogs_katacheck/version.rb

@@ -0,0 +1,3 @@
+module OGSKataCheck
+  VERSION = "0.1.0"
+end

data/ogs_katacheck.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/ogs_katacheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ogs_katacheck"
+  spec.version       = OGSKataCheck::VERSION
+  spec.authors       = ["RubyMineshaft"]
+  spec.email         = ["rubymineshaft@online-go.com"]
+
+  spec.summary       = %q{CLI that checks user submitted moves against AI game reviews.}
+  spec.description   = %q{This CLI gem is written for OGS team members in order to aid in investigating suspicions of botting.}
+  spec.homepage      = "https://github.com/RubyMineshaft/ogs_katacheck"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/RubyMineshaft/ogs_katacheck/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: ogs_katacheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RubyMineshaft
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-22 00:00:00.000000000 Z
+dependencies: []
+description: This CLI gem is written for OGS team members in order to aid in investigating
+  suspicions of botting.
+email:
+- rubymineshaft@online-go.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/ogs-katacheck
+- bin/setup
+- lib/ogs_katacheck.rb
+- lib/ogs_katacheck/cli.rb
+- lib/ogs_katacheck/full_review.rb
+- lib/ogs_katacheck/review.rb
+- lib/ogs_katacheck/version.rb
+- ogs_katacheck.gemspec
+homepage: https://github.com/RubyMineshaft/ogs_katacheck
+licenses: []
+metadata:
+  homepage_uri: https://github.com/RubyMineshaft/ogs_katacheck
+  source_code_uri: https://github.com/RubyMineshaft/ogs_katacheck
+  changelog_uri: https://github.com/RubyMineshaft/ogs_katacheck/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.10
+signing_key:
+specification_version: 4
+summary: CLI that checks user submitted moves against AI game reviews.
+test_files: []