sh19910711/codeforces-api.rb

# Codeforces API Client Library

The wrapper library for [Codeforces API](http://codeforces.com/api/help) written in Ruby.

[![Gem Version](https://img.shields.io/gem/v/codeforces.svg?style=flat)](https://rubygems.org/gems/codeforces)
[![API Doc](http://img.shields.io/badge/RubyDocs-API-green.svg?style=flat)](http://www.rubydoc.info/github/sh19910711/codeforces-api.rb)
[![Travis CI Build Status](https://img.shields.io/travis/sh19910711/codeforces-api.rb.svg?style=flat)](https://travis-ci.org/sh19910711/codeforces-api.rb)
[![Code Climate](https://img.shields.io/codeclimate/github/sh19910711/codeforces-api.rb.svg?style=flat)](https://codeclimate.com/github/sh19910711/codeforces-api.rb)
[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/sh19910711/codeforces-api.rb.svg?style=flat)](https://codeclimate.com/github/sh19910711/codeforces-api.rb)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/x44tj9b4n4sgt0qx/branch/master?svg=true)](https://ci.appveyor.com/project/sh19910711/codeforces-api.rb/branch/master)
[![Circle CI](https://circleci.com/gh/sh19910711/codeforces-api.rb/tree/master.svg?style=svg)](https://circleci.com/gh/sh19910711/codeforces-api.rb/tree/master)

![Demo](https://raw.githubusercontent.com/sh19910711/test/afbd63b242a3489f0b962359fb96e03fe9cd1c1f/output-16.gif)

## 0. Installation

Add this line to your application's Gemfile:

```ruby
gem "codeforces"
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install codeforces

## 1. Usage

### Helper Method

```ruby
require "codeforces"

Codeforces.each_contest do |contest|
  puts contest.name
end
```

```ruby
require "codeforces"

tourist = Codeforces.user("tourist")

puts tourist.rating
# -> 3254

puts tourist.rank
# -> international grandmaster
```

See also: [rubydocs](http://www.rubydoc.info/github/sh19910711/codeforces-api.rb/Codeforces/Helper)

### API Access

```ruby
require "codeforces"

Codeforces.api.contest.list.each do |contest|
  puts contest.name
end
```

See also: http://codeforces.com/api/help/methods

## 2. Contributing

1. Fork it ( https://github.com/sh19910711/codeforces-api.rb/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request