ruby_vsts

An unofficial Microsoft Visual Studio Team Services (VSTS) API client in Ruby

Gem Version Code Climate Issue Count Test Coverage

About

This will be a Ruby gem to connect to the Microsoft Visual Studio online (VSTS) Rest API. It may also work with recent versions of TFS too. Work is heavily in progress!

Install

Easy way

gem install ruby_vsts

Secure way

Add the public signing key to verify signature:

gem cert --add <(curl -Ls https://raw.github.com/prodexity/ruby_vsts/master/certs/ruby_vsts-gem-public_cert.pem)

Install with checking signatures:

gem install ruby_vsts -P HighSecurity

Usage

Setup

require 'ruby_vsts'

VSTS.configure do |config|
  config.personal_access_token = "YOUR_PERSONAL_ACCESS_TOKEN"
  config.base_url = "https://YOUR_INSTANCE.visualstudio.com/"
end

Finding changesets

VSTS::Changeset.find(72300) # find changeset by id
VSTS::Changeset.find_all(author: "[email protected]") # find by author
VSTS::Changeset.find_all(fromId: 1000, toId: 1200) # find by id range
VSTS::Changeset.find_all(fromDate: "03-01-2017", toDate: "03-18-2017-2:00PM") # find by date range
VSTS::Changeset.find_all(itemPath: "$/Fabrikam-Fiber-TFVC/Program.cs") # find by item path
VSTS::Changeset.find_all(top: 20, skip: 100) # paging
# ...

Getting changes in a changeset

changeset = VSTS::Changeset.find(72300)
changes = changeset.changes

Getting change items

item = changes[0]
file_contents = item.get # current version

Please see specs and the source code for further examples.