Project

rutrack

0.0
No commit activity in last 3 years
No release in over 3 years
JetBrains youTrack Rest API Client in Ruby. Forked from youtrack gem (by John Faucett)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
~> 1.3.10
>= 0
~> 2.14.1
~> 2.8.0
~> 1.17.1

Runtime

 Project Readme

Rutrack

YouTrack REST API Client written in Ruby

Gem Version

New in this release

Max issues option & Filter support
  • Pass max issues & filter in get_issues_for request

Example:

filter = "Username: -{No username}" # youtrack-style filter
max = 5000 # max issues to grab
client.projects.get_issues_for(project_name, max, filter)

Note: Default max value for issues to load via API - 500. You can go to Settings page in Admin menu > "Max Issues to Export" and change that value.

Installation

Add this line to your application's Gemfile:

gem 'rutrack', '0.0.12'

And then execute:

$ bundle

Usage

client = Youtrack::Client.new do |c|
  c.url = "https://example.com"
  c.login = "root"
  c.password = "root"

  # Hook into the Net::HTTP set_debug_output method for debugging HTTP Request/Response Cycles
  c.debug = true
end

# Now connect to the server
# It sets the Cookies and returns the Connection response status code
client.connect!

Examples

To get a feel for the API browse the examples directory.

Issues

Any issues or bugs should be well documented submit as many details as possible. The best issues have the following characteristics:

  1. Detail description with a title that conveys the problem well.
  2. Gists and/or failing tests that show under what conditions the problem occurs.
  3. Environment information, platform, gem version, etc.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Write your feature in Cucumber.
  4. Commit your changes (git commit -am 'Add some feature')
  5. Make sure your feature and (optional) Rspec test are green.
  6. Rebase from master.
  7. Push to the branch (git push origin my-new-feature)
  8. Create new Pull Request.