codeforces_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ca7a0de1e263b7325b48009dcc33ef3ee2b9078
+  data.tar.gz: 59268e75efd87ab4e7a8057e99197ef5ae112292
+SHA512:
+  metadata.gz: 8f9ced42650bc50aad25b9a2447957f259e38f6e03f2d795c77c4dbd4c5773803afb7d4540254605b465e3236b16158689a49d80746a128ba28cfd19219077e9
+  data.tar.gz: 09f35c05d4864106081024bb32361f1519127ab687b99c3b121ed1b799ad246531653e921e6f57029bd4761723227402c79301603ccdc688d3880fe7611ccd35

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codeforces_api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,69 @@
+# CodeforcesAPI
+
+a ruby wrapper of [codeforces api][cfapi].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codeforces_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codeforces_api
+
+## Usage
+
+### Configuration
+
+```ruby
+CodeforcesAPI.configure do |config|
+  config.key    = YOUR_API_KEY
+  config.secret = YOUR_API_SECRET
+end
+```
+
+once you setup the api key, all the methods are through authorization.
+if you have not set up the key info, all the methods are anonymouse.
+
+```ruby
+CodeforcesAPI.reset!
+```
+
+this will clear the api key info.
+
+
+### Methods
+
+let's take me(delta\_4d) as an example
+
+```ruby
+me, tourist = CodeforcesAPI.user.info('delta_4d', 'tourist')
+puts me.rank      # master
+puts tourist.rank # international grandmaster
+```
+
+you can also use the `user` object
+
+```ruby
+user = CodeforcesAPI.user
+first_contest = user.rating('delta_4d')[0]
+puts "#{first_contest.contestName} #{first_contest.newRating}"
+# Codeforces Beta Round #30 (Codeforces format) 1430
+```
+
+as you can see, the usage are pretty much the same as in the [official doc][cfapi].
+
+## Contributing
+
+feel free to file an issue or send a pr.
+
+
+
+[cfapi]: http://codeforces.com/api/help

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

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

data/bin/setup

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

data/codeforces_api.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'codeforces_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "codeforces_api"
+  spec.version       = CodeforcesAPI::VERSION
+  spec.authors       = ["delta"]
+  spec.email         = ["delta4d@gmail.com"]
+
+  spec.summary       = %q{a ruby wrapper of codeforces api}
+  spec.description   = %q{a ruby wrapper of codeforces api}
+  spec.homepage      = "https://github.com/delta4d/codeforces_api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/codeforces_api.rb

@@ -0,0 +1,20 @@
+require File.expand_path("../codeforces_api/client",        __FILE__)
+require File.expand_path("../codeforces_api/version",       __FILE__)
+
+module CodeforcesAPI
+  class << self
+    include CodeforcesAPI::Configuration
+
+    def client
+      return @client if defined?(@client)
+      @client ||= CodeforcesAPI::Client.new(options)
+    end
+
+    private
+
+    def method_missing method, *args, &block
+      return super unless client.respond_to?(method)
+      client.send(method, *args, &block)
+    end
+  end
+end

data/lib/codeforces_api/client.rb

@@ -0,0 +1,43 @@
+require 'json'
+require 'net/http'
+require 'digest/sha2'
+
+require File.expand_path('../client/user',       __FILE__)
+require File.expand_path('../client/helper',     __FILE__)
+require File.expand_path('../configuration',     __FILE__)
+require File.expand_path('../client/contest',    __FILE__)
+require File.expand_path('../client/problemset', __FILE__)
+
+require File.expand_path('../object/user',               __FILE__)
+require File.expand_path('../object/hack',               __FILE__)
+require File.expand_path('../object/party',              __FILE__)
+require File.expand_path('../object/member',             __FILE__)
+require File.expand_path('../object/contest',            __FILE__)
+require File.expand_path('../object/problem',            __FILE__)
+require File.expand_path('../object/submission',         __FILE__)
+require File.expand_path('../object/ranklist_row',       __FILE__)
+require File.expand_path('../object/rating_change',      __FILE__)
+require File.expand_path('../object/problem_result',     __FILE__)
+require File.expand_path('../object/problem_statistics', __FILE__)
+
+module CodeforcesAPI
+  class Client
+    include CodeforcesAPI::Configuration
+
+    def initialize options = {}
+      options.each{ |k, v| instance_variable_set(:"@#{k}", v) }
+    end
+
+    def user
+      @user ||= CodeforcesAPI::MethodClass::User.new
+    end
+
+    def contest
+      @contest ||= CodeforcesAPI::MethodClass::Contest.new
+    end
+
+    def problemset
+      @problemset ||= CodeforcesAPI::MethodClass::ProblemSet.new
+    end
+  end
+end

data/lib/codeforces_api/client/contest.rb

@@ -0,0 +1,58 @@
+module CodeforcesAPI
+  module MethodClass
+    class Contest
+      def hacks contestId
+        params = {'contestId' => contestId}
+        json_request = CodeforcesAPI.client.get('contest.hacks', params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_hacks = json_request['result']
+          hacks = json_hacks.collect{ |h| CodeforcesAPI::Object::Hack.new(h) }
+        end
+      end
+
+      def list gym = false
+        params = {'gym' => gym}
+        json_request = CodeforcesAPI.client.get('contest.list', params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_contests = json_request['result']
+          contests = json_contests.collect{ |c| CodeforcesAPI::Object::Contest.new(c) }
+        end
+      end
+
+      def standings contestId, optional_params = {}
+        required_params = {'contestId' => contestId}
+        json_request = CodeforcesAPI.client.get('contest.standings', required_params, optional_params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_result = json_request['result']
+
+          json_contest = json_result['contest']
+          json_problems = json_result['problems']
+          json_rows = json_result['rows']
+
+          {
+            'contest' => CodeforcesAPI::Object::Contest.new(json_contest),
+            'problems' => json_problems.collect{ |p| CodeforcesAPI::Object::Problem.new(p) },
+            'rows' => json_rows.collect{ |r| CodeforcesAPI::Object::RanklistRow.new(r) },
+          }
+        end
+      end
+
+      def status contestId, optional_params = {}
+        required_params = {'contestId' => contestId}
+        json_request = CodeforcesAPI.client.get('contest.status', required_params, optional_params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_submissions = json_request['result']
+          submissinos = json_submissions.collect{ |sub| CodeforcesAPI::Object::Submission.new(sub) }
+        end
+      end
+    end
+  end
+end

data/lib/codeforces_api/client/helper.rb

@@ -0,0 +1,33 @@
+module CodeforcesAPI
+  class Client
+    API_URI = 'http://codeforces.com/api'
+
+    def rand6
+      [*0..5].collect{ rand(10) }.join
+    end
+
+    def post_form options = {}
+      options.collect{ |k, v| "#{k}=#{v}" }.join('&')
+    end
+
+    def request_url method, _params
+      url = "#{API_URI}/#{method}?#{post_form(_params)}"
+      return url unless using_api?
+      salt = rand6()
+      time = Time.now.to_i
+      info = {'apiKey' => @key, 'time' => time}
+      params = _params.merge(info).map{|k, v| [k.to_s, v]}.sort.to_h
+      digest_string = "#{salt}/#{method}?#{post_form(params)}##{@secret}"
+      api_sig = Digest::SHA2.new(512).hexdigest(digest_string)
+      params.merge!('apiSig'=>"#{salt}#{api_sig}")
+      "#{API_URI}/#{method}?#{post_form(params)}"
+    end
+
+    def get method, required_params, optional_params = {}
+      params = required_params.merge(optional_params)
+      uri = URI(request_url(method, params))
+      http_response = Net::HTTP.get(uri)
+      json_response = JSON.parse(http_response)
+    end
+  end
+end

data/lib/codeforces_api/client/problemset.rb

@@ -0,0 +1,33 @@
+module CodeforcesAPI
+  module MethodClass
+    class ProblemSet
+      def problems *tags
+        params = {'tags' => tags.join(';')}
+        json_request = CodeforcesAPI.client.get('problemset.problems', params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_result = json_request['result']
+          json_problems = json_result['problems']
+          json_problemstatistics = json_result['problemStatistics']
+
+          {
+            'problems' => json_problems.collect{ |p| CodeforcesAPI::Object::Problem.new(p) },
+            'problemStatistics' => json_problemstatistics.collect{ |ps| CodeforcesAPI::Object::ProblemStatistics.new(ps) },
+          }
+        end
+      end
+
+      def recentStatus count
+        params = {'count' => count}
+        json_request = CodeforcesAPI.client.get('problemset.recentStatus', params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_sumbissions = json_request['result']
+          submissions = json_sumbissions.collect{ |sub| CodeforcesAPI::Object::Submission.new(sub) }
+        end
+      end
+    end
+  end
+end

data/lib/codeforces_api/client/user.rb

@@ -0,0 +1,49 @@
+module CodeforcesAPI
+  module MethodClass
+    class User
+      def info *handles
+        params = {'handles' => handles.join(';')}
+        json_request = CodeforcesAPI.client.get('user.info', params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_users = json_request['result']
+          users = json_users.collect{ |user| CodeforcesAPI::Object::User.new(user) }
+        end
+      end
+
+      def ratedList activeOnly = true
+        params = {'activeOnly' => activeOnly}
+        json_request = CodeforcesAPI.client.get('user.ratedList', params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_users = json_request['result']
+          users = json_users.collect{ |user| CodeforcesAPI::Object::User.new(user) }
+        end
+      end
+
+      def rating handle
+        params = {'handle' => handle}
+        json_request = CodeforcesAPI.client.get('user.rating', params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_ratingchanges = json_request['result']
+          ratingchanges = json_ratingchanges.collect{ |rc| CodeforcesAPI::Object::RatingChange.new(rc) }
+        end
+      end
+
+      def status handle, optional_params
+        required_params = {'handle' => handle}
+        json_request = CodeforcesAPI.client.get('user.status', required_params, optional_params)
+        if json_request['status'] != 'OK'
+          raise json_request['result']
+        else
+          json_submissions = json_request['result']
+          submissions = json_submissions.collect{ |sub| CodeforcesAPI::Object::Submission.new(sub) }
+        end
+      end
+    end
+  end
+end

data/lib/codeforces_api/configuration.rb

@@ -0,0 +1,26 @@
+module CodeforcesAPI
+  module Configuration
+    ATTRS = [:key, :secret, :use_api].freeze
+
+    attr_accessor *ATTRS
+
+    def configure
+      @use_api = true
+      yield self
+    end
+
+    def options
+      ATTRS.collect{ |attr| [attr, instance_variable_get(:"@#{attr}")] }.to_h
+    end
+
+    def using_api?
+      @use_api
+    end
+
+    def reset!
+      @key        = nil
+      @secret     = nil
+      @use_api    = false
+    end
+  end
+end

data/lib/codeforces_api/object/contest.rb

@@ -0,0 +1,31 @@
+module CodeforcesAPI
+  module Object
+    class Contest
+      ATTRS = [
+        :id,
+        :name,
+        :type,
+        :phase,
+        :frozen,
+        :durationSeconds,
+        :startTimeSeconds,
+        :relativeTimeSeconds,
+        :preparedBy,
+        :websiteUrl,
+        :description,
+        :difficulty,
+        :kind,
+        :icpcRegion,
+        :country,
+        :city,
+        :season,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize contest
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", contest[attr.to_s]) }
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/hack.rb

@@ -0,0 +1,25 @@
+module CodeforcesAPI
+  module Object
+    class Hack
+      ATTRS = [
+        :id,
+        :creationTimeSeconds,
+        :hacker,
+        :defender,
+        :verdict,
+        :problem,
+        :test,
+        :judgeProtocol,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize hack
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", hack[attr.to_s]) }
+        @hacker   = Party.new(@hacker) if @hacker
+        @defender = Party.new(@defender) if @defender
+        @problem  = Problem.new(@problem) if @problem
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/member.rb

@@ -0,0 +1,15 @@
+module CodeforcesAPI
+  module Object
+    class Member
+      ATTRS = [
+        :handle
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize mem
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", mem[attr.to_s]) }
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/party.rb

@@ -0,0 +1,23 @@
+module CodeforcesAPI
+  module Object
+    class Party
+      ATTRS = [
+        :contestId,
+        :members,
+        :participantType,
+        :teamId,
+        :teamName,
+        :ghost,
+        :room,
+        :startTimeSeconds,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize party
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", party[attr.to_s]) }
+        @members = @members.map{|mem| Member.new(mem)} if @members
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/problem.rb

@@ -0,0 +1,20 @@
+module CodeforcesAPI
+  module Object
+    class Problem
+      ATTRS = [
+        :contestId,
+        :index,
+        :name,
+        :type,
+        :points,
+        :tags,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize prob
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", prob[attr.to_s]) }
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/problem_result.rb

@@ -0,0 +1,19 @@
+module CodeforcesAPI
+  module Object
+    class ProblemResult
+      ATTRS = [
+        :points,
+        :penalty,
+        :rejectedAttemptCount,
+        :type,
+        :bestSubmissionTimeSeconds,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize problem_result
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", problem_result[attr.to_s]) }
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/problem_statistics.rb

@@ -0,0 +1,17 @@
+module CodeforcesAPI
+  module Object
+    class ProblemStatistics
+      ATTRS = [
+        :contestId,
+        :index,
+        :solvedCount,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize probstat
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", probstat[attr.to_s]) }
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/ranklist_row.rb

@@ -0,0 +1,25 @@
+module CodeforcesAPI
+  module Object
+    class RanklistRow
+      ATTRS = [
+        :party,
+        :rank,
+        :points,
+        :penalty,
+        :successfulHackCount,
+        :unsuccessfulHackCount,
+        :problemResults,
+        :lastSubmissionTimeSeconds,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize ranklist_row
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", ranklist_row[attr.to_s]) }
+        @party = Party.new(@party) if @party
+        @problemResults = @problemResults.map { |pr| ProblemResult.new(pr) } if @problemResults
+      end
+    end
+  end
+end
+

data/lib/codeforces_api/object/rating_change.rb

@@ -0,0 +1,20 @@
+module CodeforcesAPI
+  module Object
+    class RatingChange
+      ATTRS = [
+        :contestId,
+        :contestName,
+        :rank,
+        :ratingUpdateTimeSeconds,
+        :oldRating,
+        :newRating,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize rate
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", rate[attr.to_s]) }
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/submission.rb

@@ -0,0 +1,28 @@
+module CodeforcesAPI
+  module Object
+    class Submission
+      ATTRS = [
+        :id,
+        :contestId,
+        :creationTimeSeconds,
+        :relativeTimeSeconds,
+        :problem,
+        :author,
+        :programmingLanguage,
+        :verdict,
+        :testset,
+        :passedTestCount,
+        :timeConsumedMillis,
+        :memoryConsumedBytes,
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize sub
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", sub[attr.to_s]) }
+        @problem = Problem.new(@problem) if @problem
+        @author = Party.new(@author) if @author
+      end
+    end
+  end
+end

data/lib/codeforces_api/object/user.rb

@@ -0,0 +1,31 @@
+module CodeforcesAPI
+  module Object
+    class User
+      ATTRS = [
+        :handle,
+        :email,
+        :vkId,
+        :openId,
+        :firstName,
+        :lastName,
+        :country,
+        :city,
+        :organization,
+        :contribution,
+        :rank,
+        :rating,
+        :maxRank,
+        :maxRating,
+        :lastOnlineTimeSeconds,
+        :registrationTimeSeconds
+      ].freeze
+
+      attr_reader *ATTRS
+
+      def initialize user
+        ATTRS.each { |attr| instance_variable_set("@#{attr}", user[attr.to_s]) }
+      end
+    end
+  end
+end
+

data/lib/codeforces_api/version.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: codeforces_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- delta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: a ruby wrapper of codeforces api
+email:
+- delta4d@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codeforces_api.gemspec
+- lib/codeforces_api.rb
+- lib/codeforces_api/client.rb
+- lib/codeforces_api/client/contest.rb
+- lib/codeforces_api/client/helper.rb
+- lib/codeforces_api/client/problemset.rb
+- lib/codeforces_api/client/user.rb
+- lib/codeforces_api/configuration.rb
+- lib/codeforces_api/object/contest.rb
+- lib/codeforces_api/object/hack.rb
+- lib/codeforces_api/object/member.rb
+- lib/codeforces_api/object/party.rb
+- lib/codeforces_api/object/problem.rb
+- lib/codeforces_api/object/problem_result.rb
+- lib/codeforces_api/object/problem_statistics.rb
+- lib/codeforces_api/object/ranklist_row.rb
+- lib/codeforces_api/object/rating_change.rb
+- lib/codeforces_api/object/submission.rb
+- lib/codeforces_api/object/user.rb
+- lib/codeforces_api/version.rb
+homepage: https://github.com/delta4d/codeforces_api
+licenses: []
+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.2.3
+signing_key: 
+specification_version: 4
+summary: a ruby wrapper of codeforces api
+test_files: []
+has_rdoc: