ruby-lichess 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 77bf772731d1cae63c57d0e68591cbc49f5451cf
-  data.tar.gz: f73c78707214e0b43d80506b3d637c6fb0e506fb
+SHA256:
+  metadata.gz: 8e1a27261e0a8bc8e8c2bdbdf74a1260f3389418698dfc9db8137f02d7ff7e62
+  data.tar.gz: 01a6467e60c0c1f5bea3ef40c8164e02246bd3f3fc02687541638f2d3ab9f2dc
 SHA512:
-  metadata.gz: 6dd399d9c41d566a4910b56f3bc941f1ed02065266fb510a8bf12a2d4f4b9d627397e9982e9f349c9f5dee64b2605ce806de745f53fd782750b3b1b009ab5dd1
-  data.tar.gz: ac217b9dbd147b6345852a6568cdaa1b157c7089f562786b2cf667d8523a4f57027d6df47897dc576d3eb5649da7afb2747dcd8f0ea6170b2861cb73b9ae64a2
+  metadata.gz: 8de88aa6328173b70c815516aafdb31d63800a57941d05f2450e4f6820f2cb14d056449cb07f492e5f9288843f6a4b4d2cb5f640224d11c94586bd706cbdbd24
+  data.tar.gz: 23dc2c584f5fb867958fc97bd908269942d1f12239b7ea8cb301106f3a8f3edb678396dac39f3dab23eaaafc4708eb1effff952cc4b46dd866b42b6e26fba456

data/.gitignore

@@ -7,6 +7,8 @@
 /spec/reports/
 /tmp/
 
+Gemfile.lock
+
 # rspec failure tracking
 .rspec_status
 ruby-lichess-*.gem

data/README.md

@@ -18,6 +18,14 @@ Or install it yourself as:
 
 ## Usage
 
+### Client
+
+Get started by first creating a client
+
+```
+lichess = Lichess::Client.new(LICHESS_API_TOKEN)
+```
+
 ### Users
 
 *All Top Ten*
@@ -50,6 +58,12 @@ Get a users data
 result = lichess.users.get("username")
 ```
 
+Get multiple users by passing in an array
+
+```
+result = lichess.users.get(["username1", "username2"])
+```
+
 ## Development
 
 ## Contributing

data/lib/lichess/exceptions.rb

@@ -2,6 +2,7 @@ module Lichess
   module Exception
     class UserNotFound < StandardError; end
     class TooManyGames < StandardError; end
+    class InvalidParameter < StandardError; end
   end
 end
 

data/lib/lichess/games_gateway.rb

@@ -6,6 +6,10 @@ module Lichess
 
     MAX_GAMES = 30
 
+    VALID_PARAMS = {
+      users_games: %w{perf perfType since until max vs rated color analysed ongoing movies pgnInJson tags clocks evals opening players ongoing, num_games}.map(&:to_sym)
+    }
+
     def initialize(client)
       @client = client
     end
@@ -21,6 +25,7 @@ module Lichess
       JSON.parse(result.body)
     end
 
+
     def users_games(user_id, options = {}, &blk)
       num_games = options[:num_games] || 10
 
@@ -28,10 +33,17 @@ module Lichess
         raise Exception::TooManyGames.new("Cannot request more than 30 games")
       end
 
+      invalid_params = options.keys.reject { |k| VALID_PARAMS[:users_games].include? k }
+      raise Exception::InvalidParameter.new("#{invalid_params.join(",")} parameters were supplied, but are invalid") if invalid_params.any?
+
       path = "/api/games/user/#{user_id}?max=#{num_games}"
-      path << "&ongoing=#{options[:ongoing]}" if options[:ongoing]
+
+      # kept to keep backward compat
       path << "&perfType=#{options[:perf]}" if options[:perf]
-      path << "&vs=#{options[:vs]}" if options[:vs]
+
+      options.each do |key, value|
+        path << "&#{key}=#{value}"
+      end
 
       result = @client.get(path, http_headers: ndjson_headers)
       stringio = StringIO.new(result.body)

data/lib/lichess/version.rb

@@ -1,3 +1,3 @@
 module Lichess
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/ruby-lichess.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ndjson", "~> 1.0"
   spec.add_dependency "http", "~> 4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "dotenv", "2.5.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lichess
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - omgrr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ndjson
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +118,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -150,8 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby library for lichess api

data/Gemfile.lock

@@ -1,63 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ruby-lichess (0.2.1)
-      http (~> 4.0)
-      ndjson (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    dotenv (2.5.0)
-    http (4.1.1)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http_parser.rb (0.6.0)
-    method_source (0.9.0)
-    ndjson (1.0.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (4.0.1)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  dotenv (= 2.5.0)
-  pry (~> 0.11)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  ruby-lichess!
-
-BUNDLED WITH
-   1.16.1