ogs_katacheck 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1aab2ad84305b247e1322ca044945c54f70b791018335241fad5dd84dd366334
-  data.tar.gz: d27f633ba9711c8919dbd31a3804894223d8abe580fe038b4fada757f0c74690
+  metadata.gz: c92d299392ca4458d86bcc62e2caaff21685c32a5e3e879068eb8f5c940a894b
+  data.tar.gz: 273ef4d65160c92bedc574a98b27c091de761147ccb2e9f60a4be96ae6cf294e
 SHA512:
-  metadata.gz: 319fb6ca517da68aa5b239df2d2549104f2e3908fdcc2c3e022d635806db2f1b0db7967494b623f43f8b25d86803718bcee0df27a1bf9996dd5889875963472f
-  data.tar.gz: af2912f11d6146ded07656e729540a565ad06313131b3442aa67a553cb968139447d2d56e1ac621270655c58f421ed17c0bb66682b88be3574cddb46d19feb3d
+  metadata.gz: fbdf7d43f212e20bfb0972717548625b0e57c26f52e951ce1c64ffb2a99ad8dcc5bd6f70070cdc3416f30acf273a2cd85b9436ec773f7e84c919b2258c768eb6
+  data.tar.gz: 977f1cd671e47706fd97af56f5520bdd1a9165ca468f35768f221be84d658a21a0a54817a03d47acbaedf04782856e43b473b7ad57fc9f515bd1c4daf1caaf0f

data/.gitignore

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

data/CHANGELOG.md

@@ -1,4 +1,19 @@
 # Change Log
 
 ### 0.1.0
-- Added ability to check games against OGS full reviews. 
+- Added ability to check games against OGS full reviews.
+
+### 0.1.1
+- 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 

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    ogs_katacheck (0.1.5)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    multipart-post (2.1.1)
+    rake (12.3.0)
+    ruby2_keywords (0.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday
+  ogs_katacheck!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

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,12 +18,20 @@ 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.
 
+![Review Selection](https://github.com/RubyMineshaft/ogs_katacheck/blob/main/images/reviews.png)
+
 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.
 
+![Output Example](https://github.com/RubyMineshaft/ogs_katacheck/blob/main/images/output.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

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/version.rb

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

data/ogs_katacheck.gemspec

@@ -22,7 +22,8 @@ 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.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.add_runtime_dependency "faraday"
+  spec.bindir        = "bin"
+  spec.executables   = ["ogs-katacheck", "katacheck"]
   spec.require_paths = ["lib"]
 end

metadata

@@ -1,31 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: ogs_katacheck
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - RubyMineshaft
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
-dependencies: []
+date: 2020-10-23 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
+- Gemfile.lock
 - 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