/usr/share/doc/ruby-fogbugz/README.md is in ruby-fogbugz 0.2.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | [](https://travis-ci.org/firmafon/ruby-fogbugz)
[](https://codeclimate.com/github/firmafon/ruby-fogbugz)
[](https://codeclimate.com/github/firmafon/ruby-fogbugz/coverage)
# ruby-fogbugz
A very simple wrapper for the Fogbugz API. It won't give you fancy classes for everything, it'll simply aid you in sending the API requests, parsing the returned XML finally retuning you a Hash.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ruby-fogbugz'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install ruby-fogbugz
## Usage
The Fogbugz API works by sending HTTP GET parameters to the API where the GET parameter `cmd` invokes a Fogbugz method, e.g. `cmd=listProjects` to get a list of all projects, `cmd`s then accept further arguments, such as listing all cases assigned to a specific person:
cmd=search&ixAssignedTo=2&cols=sTitle,sStatus # list all cases associated to the user with ID of 2 in Fogbugz
In `ruby-fogbugz` that request would be:
```ruby
fogbugz.command(:search, :ixAssignedTo => 2, :cols => "sTitle,sStatus")
```
Returns your parsed XML:
```ruby
{
"description"=>"All open cases assigned to Simon Eskildsen",
"cases" => {
"case"=> [
{"ixBug"=>"143", "sTitle"=>"Write ruby-fogbugz documentation",
"sStatus"=>"active", "operations"=>"edit,assign,resolve,email,remind"},
{"ixBug"=>"146", "sTitle"=>"Tame a unicorn", "sStatus"=>"active",
"operations"=>"edit,assign,resolve,email,remind"},
{"ixBug"=>"152", "sTitle"=>"Hug a walrus", "sStatus"=>"active",
"operations"=>"edit,assign,resolve,email,remind"},
], "count"=>"3"
}
}
```
As you see, `ruby-fogbugz` is without magic and leaves most to the user.
`cmd` is the first argument to `Fogbugz#command`, the second argument being a `Hash` of additional GET arguments to specify the request further. You can see available `cmd`'s and arguments at the [Fogbugz API documentation][fad].
All Fogbugz API requests require a token. Thus `#authenticate` must be called on the `ruby-fogbugz` instance before `#command`'s are sent:
```ruby
require 'fogbugz'
fogbugz = Fogbugz::Interface.new(:email => 'my@email.com', :password => 'seekrit', :uri => 'https://company.fogbugz.com') # remember to use https!
fogbugz.authenticate # token is now automatically attached to every future requests
p fogbugz.command(:listPeople)
```
`#authenticate` fetches a new token every time. To avoid the extra request,
obtain a token:
```ruby
require 'fogbugz'
fogbugz = Fogbugz::Interface.new(:email => 'my@email.com', :password => 'seekrit', :uri => 'https://company.fogbugz.com') # remember to use https!
fogbugz.authenticate # token is now automatically attached to every future requests
puts "Token: #{fogbugz.token}"
```
Run the script, and initialize with the returned token:
```ruby
fogbugz = Fogbugz::Interface.new(:token => "some token to use from now on", :uri => 'https://company.fogbugz.com') # remember to use https!
```
[fad]:http://fogbugz.stackexchange.com/fogbugz-xml-api
## License
`ruby-fogbugz` is released under the MIT license.
|