Netologiest

Netology Ruby API client

API for Netology (http://netology.ru/) e-learning intergration.

Configuration

Netologiest uses anyway_config to configure client.

It has two configuration attributes:

• api_key;
• api_url.

For example (in your secrets.yml):

....
  netologiest:
    api_key: "your_api_key_here"
    api_url: "http://dev.netology.ru/content_api"
....

Usage

Course

Netologiest having only one resource at moment. It is a course. And you can get list of courses

To get a list of courses

  Netologiest::Course.list

  #=>
  [
    {
      "id" => "1",
      "name" => "Direct marketing. Basics.",
      "last_updated_at" => "1387176082"
    },
    {
      "id" => "2",
      "name" => "Test course #1",
      "last_updated_at" => "1386236837"
    },
    {
      "id" => "3",
      "name" => "How to make course.",
      "last_updated_at" => "1387176130"
    }
  ]

Also you can get detailed information about any course:

  # argument is Course ID 
  Netologiest::Course.detail(1)

  #=>
  {
    "id" => 931,
    "name" => "Name of course",
    "description" => "Description of course",
    "progress" => 0,
    "duration" => 47,
    "level" => { ... },
    "tags" => [{..}, {..}, {..}]
    ....
    "blocks" => [
      ...
      {
        "lessons" => []
      }
      ...
    ]
  }

Lesson's video

Lesson class is used to obtain iframe token or iframe url (with token)

  # returns complete URL to video iframe
  Netologiest::Lesson.video_url(course_id, lesson_id)

  # OR

  lesson = Netologiest::Lesson.new(course_id, lesson_id)
  # makes request to API and refresh lesson_token
  lesson.video_token
  # returns token
  lesson.lesson_token
  # returns complete URL
  lesson.video_url

Contributing

1. Fork it ( https://github.com/[my-github-username]/netologiest/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