ogs_katacheck 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c71349f5dd8e74429e56af1b16a8f2a5d9738d4d5f91ac0ac838a356ca119be1
-  data.tar.gz: 94a6f3d98e73634aa0f4064fcd4d8ad7d0710a8b0d8797b37ae8da0733f87529
+  metadata.gz: efcf71b47a81e504adac1957eba94c7b6e51776a663c00b07816bfe69efa5178
+  data.tar.gz: 30c6b7ff2df94ee195cd534904b5e7da6dc288bd85aec03c1e48893daa233278
 SHA512:
-  metadata.gz: 2176a2caa81063dbae9e38139a6a586be97c9eabc29dd6b79c3130db81585abde1e9761c2825af5846287a60d25b1fbd8aa79a917f93ad632f44b218075db585
-  data.tar.gz: ef0c4665c4c05ecd514c4d630460e2100459260116bd58baee63d1aa1e351b403f8688dc4b592878996f4fea1b6ba0d9a61d56149b8b96389578f053c8575755
+  metadata.gz: 44f2a9169e1d1da2ab56582d97e616035f01120ba18d890b8b433c993071c38aa0a6e66971edea630e13fdf180fb52b5e3c627e6207163b3090ac8c768251c93
+  data.tar.gz: 63be13d07b2df822864fed5c500c9645895449d3dc0a641d1f67ea09a3e54b40a93ba65dc49ec1cabbcd29bb4fdeb1ac435bd47e8473291c6d9b59de1848d842

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store

data/CHANGELOG.md

@@ -4,4 +4,19 @@
 - Added ability to check games against OGS full reviews.
 
 ### 0.1.1
-- add ogs-katacheck executable 
+- add `ogs-katacheck` executable
+
+### 0.1.2
+- add `katacheck` executable
+
+### 0.1.3
+- bug fix
+
+### 0.1.4
+- bug fix
+
+### 0.1.5
+- bug fix
+
+### 0.1.6
+- fixes bug in the way percentages are calculated

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    ogs_katacheck (0.1.1)
+    ogs_katacheck (0.1.6)
+      faraday
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -6,7 +6,7 @@ It pulls game information from the OGS API and checks the user submitted moves a
 
 ## 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/).
+**You will need to have Ruby installed on your machine to run this CLI.** If you are using a Mac, this should already be 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/). You can verify that everything is installed properly by running `ruby -v` and `gem -v`, you should see versions for both after running these commands.
 
 To install this Gem, open a terminal and run:
 
@@ -18,19 +18,21 @@ After installing OGS KataCheck, you can run it by opening a terminal and typing:
 
     $ ogs-katacheck
 
+or
+
+    $ 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.
+![Review Selection](https://github.com/RubyMineshaft/ogs_katacheck/blob/main/images/reviews.png)
 
-***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
+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.
 
-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.
+![Output Example](https://github.com/RubyMineshaft/ogs_katacheck/blob/main/images/output.png)
 
-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).
+***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.*
 
 ## Contributing
 

data/bin/katacheck

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

data/bin/ogs-katacheck

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

data/lib/ogs_katacheck.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'faraday'
 require 'json'
 require_relative "./ogs_katacheck/version"

data/lib/ogs_katacheck/full_review.rb

@@ -25,18 +25,21 @@ class FullReview
   end
 
   def self.destroy_all
-    self.all.clear 
+    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
+    white_moves = (@total_moves / 2.0).floor
+    black_moves = (@total_moves / 2.0).ceil
+
+    @black_tier_1[1] = @black_tier_1[0].to_f / black_moves * 100
+    @black_tier_2[1] = @black_tier_2[0].to_f / black_moves * 100
+    @black_tier_3[1] = @black_tier_3[0].to_f / black_moves * 100
+    @black_tier_4[1] = @black_tier_4[0].to_f / black_moves * 100
+    @white_tier_1[1] = @white_tier_1[0].to_f / white_moves * 100
+    @white_tier_2[1] = @white_tier_2[0].to_f / white_moves * 100
+    @white_tier_3[1] = @white_tier_3[0].to_f / white_moves * 100
+    @white_tier_4[1] = @white_tier_4[0].to_f / white_moves * 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]

data/lib/ogs_katacheck/version.rb

@@ -1,3 +1,3 @@
 module OGSKataCheck
-  VERSION = "0.1.1"
+  VERSION = "0.1.6"
 end

data/ogs_katacheck.gemspec

@@ -22,7 +22,10 @@ Gem::Specification.new do |spec|
   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.add_runtime_dependency "faraday"
   spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ["ogs-katacheck", "katacheck"]
   spec.require_paths = ["lib"]
 end
+
+# to release, bump version and run `bundle exec rake release` 

metadata

@@ -1,23 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: ogs_katacheck
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - RubyMineshaft
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
-dependencies: []
+date: 2020-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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: []
+executables:
+- ogs-katacheck
+- katacheck
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -25,8 +42,11 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/katacheck
 - bin/ogs-katacheck
 - bin/setup
+- images/output.png
+- images/reviews.png
 - lib/ogs_katacheck.rb
 - lib/ogs_katacheck/cli.rb
 - lib/ogs_katacheck/full_review.rb