Module: Trac

### Home Classes Methods

### In Files

- lib/trac4r/error.rb
- lib/trac4r/query.rb
- lib/trac4r/ticket.rb
- lib/trac4r/tickets.rb
- lib/trac4r/wiki.rb
- lib/trac4r.rb

### Namespace

- CLASS Trac::Base
- CLASS Trac::Query
- CLASS Trac::Ticket
- CLASS Trac::Tickets
- CLASS Trac::TracException
- CLASS Trac::Wiki

### Methods

- ::new

### Files

- README.rdoc

### Class/Module Index

Quicksearch

- Trac
- Trac::Base
- Trac::Query
- Trac::Ticket
- Trac::Tickets
- Trac::TracException
- Trac::Wiki

No matching classes.

# Trac

Copyright © 2008 Niklas E. Cathor <niklas@brueckenschlaeger.de>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

DON’T USE IT IF YOU’RE AN ASSHOLE!

Copyright © 2008 Niklas E. Cathor <niklas@brueckenschlaeger.de>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

DON’T USE IT IF YOU’RE AN ASSHOLE!

This module wraps the XMLRPC interface of trac (trac.edgewall.org/) into a ruby library. You can now easily access trac from any ruby application without having to handle all the (trivial) XMLRPC calls.

Example (receive list of opened tickets):

    require 'trac4r/trac'
    trac = Trac.new "http://dev.example.com/trac/my_awesome_project"
    trac.tickets.list :include_closed => false #=> [7,9,3,5,14,...]

Receive one single ticket

    ticket = trac.tickets.get 9 #=> #<Trac::Ticket:0xb76de9b4 ... >
    ticket.summary #=> 'foo'
    ticket.description #=> 'bar'

See documentation for Trac::Ticket for what methods you can call on ticket.

Create a new ticket

    trac.tickets.create "summary", "description", :type => 'defect', :version => '1.0', :milestone => 'bug free' #=> 10

summary and description are required, the rest is optional. It can be one of the following: :severity, :milestone, :status, :type, :priority, :version, :reporter, :owner, :cc, :keywords

### Public Class Methods

new(url, user=nil,pass=nil) click to toggle source

returns a new instance of Trac::Base

    # File lib/trac4r.rb, line 58
    def self.new url, user=nil,pass=nil
      Base.new url,user,pass
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.