ruby-lichess 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0fd7dc34cb7fb1e7367a6ca2de585a33688cf60
+  data.tar.gz: fef0ebc23442f86bf7ae1d3f1fd9240b5113604f
+SHA512:
+  metadata.gz: 6f443d56fe5a3d729dfda3a527d87cbcf979944167c94e4fb37556ae18770d394aa910dd31ef48c15069c7940fcdd67723dbc6dcb8bd23fd4b8a6db613d7b7d3
+  data.tar.gz: 33b554dd1450a2f19bd9750bbbd53af1ee75bac21b6b8db028d969ece36463fbd851f86e9aea5f15db89e3a7d86ef7f211dee7b8735e2da0cc0d0f2d44480346

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruby-lichess.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    ruby-lichess (0.1.0)
+      http (~> 4.0)
+      ndjson (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.5.0)
+    http (4.0.0)
+      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 (3.0.3)
+    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.5)
+
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# Ruby::Lichess
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-lichess'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-lichess
+
+## Usage
+
+### Users
+
+*All Top Ten*
+
+Get the top ten of all different types of games.
+
+```
+result = lichess.users.all_top_ten()
+```
+
+*Get leaderboard*
+
+Get the leaderboard for the specified variant
+
+```
+result = lichess.users.leaderboard("blitz")
+```
+
+Can specify the number of users to get for the particular variant
+
+```
+result = lichess.users.leaderboard("blitz", 100)
+```
+
+
+Get users data
+
+Get users current activity
+
+### Games
+
+
+
+## Development
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/omgrr/ruby-lichess.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby/lichess"
+
+# 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/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/lichess.rb

@@ -0,0 +1,9 @@
+require "lichess/version"
+
+require "lichess/client"
+require "lichess/exceptions"
+require "lichess/games_gateway"
+require "lichess/users_gateway"
+
+module Lichess
+end

data/lib/lichess/client.rb

@@ -0,0 +1,53 @@
+require "net/http"
+require "http"
+
+module Lichess
+  class Client
+    attr_reader :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    def users
+      @users_gateway ||= UsersGateway.new(self)
+    end
+
+    def games
+      @games_gateway ||= GamesGateway.new(self)
+    end
+
+    def get(path, http_headers: {})
+      url = "#{base_url}#{path}"
+
+      http_headers[:accept] ||= "application/vnd.lichess.v3+json"
+      http_headers[:content_type] ||= "application/json"
+      http_headers[:authorization] ||= "Bearer #{@token}"
+
+      response = HTTP
+        .headers(http_headers)
+        .get(url)
+
+      return response
+    end
+
+    def post(path, body: nil, http_headers: {})
+      url = "#{base_url}#{path}"
+
+      http_headers[:accept] ||= "application/vnd.lichess.v3+json"
+      http_headers[:content_type] ||= "application/json"
+
+      response = HTTP
+        .headers(http_headers)
+        .post(url)
+
+      return response
+    end
+
+    private
+
+    def base_url
+      "https://lichess.org"
+    end
+  end
+end

data/lib/lichess/exceptions.rb

@@ -0,0 +1,7 @@
+module Lichess
+  module Exception
+    class UserNotFound < StandardError; end
+    class TooManyGames < StandardError; end
+  end
+end
+

data/lib/lichess/games_gateway.rb

@@ -0,0 +1,62 @@
+require "ndjson"
+
+module Lichess
+  class GamesGateway
+    attr_reader :client
+
+    MAX_GAMES = 30
+
+    def initialize(client)
+      @client = client
+    end
+
+    def export(game_id)
+      path = "/game/export/#{game_id}"
+
+      http_headers = {}
+      http_headers[:accept] = "application/json"
+      http_headers[:content_type] = "application/json"
+
+      result = @client.get(path, http_headers: http_headers)
+      JSON.parse(result.body)
+    end
+
+    def users_games(user_id, options = {}, &blk)
+      num_games = options[:num_games] || 10
+
+      if num_games > MAX_GAMES
+        raise Exception::TooManyGames.new("Cannot request more than 30 games")
+      end
+
+      path = "/api/games/user/#{user_id}?max=#{num_games}"
+      path << "&ongoing=#{options[:ongoing]}" if options[:ongoing]
+      path << "&perfType=#{options[:perf]}" if options[:perf]
+      path << "&vs=#{options[:vs]}" if options[:vs]
+
+      result = @client.get(path, http_headers: ndjson_headers)
+      stringio = StringIO.new(result.body)
+
+      NDJSON::Parser.new(stringio).each do |json|
+        yield json
+      end
+    end
+
+    def ongoing_games
+      path = "/api/account/playing"
+
+      result = @client.get(path)
+
+      JSON.parse(result.body)
+    end
+
+    private
+
+    def ndjson_headers
+      http_headers = {}
+      http_headers[:accept] = "application/x-ndjson"
+      http_headers[:content_type] = "application/x-ndjson"
+
+      http_headers
+    end
+  end
+end

data/lib/lichess/users_gateway.rb

@@ -0,0 +1,43 @@
+require "json"
+
+module Lichess
+  class UsersGateway
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get(username)
+      path = "/api/user/#{username}"
+      result = @client.get(path)
+
+      if result.code == 404
+        raise Lichess::Exception::UserNotFound.new("#{username} not found")
+      end
+
+      JSON.parse(result.body)
+    end
+
+    def activity(username)
+      path = "/api/user/#{username}/activity"
+      result = @client.get(path)
+
+      if result.body.to_s == "[]"
+        raise Lichess::Exception::UserNotFound.new("#{username} not found")
+      end
+
+      JSON.parse(result.body)
+    end
+
+    def all_top_ten
+      path = "/player"
+      JSON.parse(@client.get(path).body)
+    end
+
+    def leaderboard(variant, number_of_users = 10)
+      path = "/player/top/#{number_of_users}/#{variant}"
+      JSON.parse(@client.get(path).body)
+    end
+  end
+end

data/lib/lichess/version.rb

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

data/ruby-lichess.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lichess/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-lichess"
+  spec.version       = Lichess::VERSION
+  spec.authors       = ["omgrr"]
+  spec.email         = ["jerwis0731@gmail.com"]
+
+  spec.summary       = %q{Ruby library for lichess api}
+  spec.description   = %q{Ruby library for lichess api}
+  spec.homepage      = "https://github.com/omgrr/ruby-lichess.git"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_dependency "ndjson", "~> 1.0"
+  spec.add_dependency "http", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "dotenv", "2.5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lichess
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- omgrr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ndjson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Ruby library for lichess api
+email:
+- jerwis0731@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lichess.rb
+- lib/lichess/client.rb
+- lib/lichess/exceptions.rb
+- lib/lichess/games_gateway.rb
+- lib/lichess/users_gateway.rb
+- lib/lichess/version.rb
+- ruby-lichess.gemspec
+homepage: https://github.com/omgrr/ruby-lichess.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: Ruby library for lichess api
+test_files: []