Changes between Version 66 and Version 67 of XmlRpcPlugin

Timestamp:

Sep 3, 2008, 12:21:53 AM (16 years ago)

Author:

niklas.cathor@…

Comment:

--

XmlRpcPlugin

@@ -171 +171 @@
          
 See [/attachment/wiki/XmlRpcPlugin/trac_xml_rpc_example_java.zip?format=raw this example zip file] 
-         
+
+=== Using from Ruby ===
+You can either use the XMLRPC functionality included in the [http://ruby-doc.org/stdlib/libdoc/xmlrpc/rdoc/index.html Ruby Standard Library] or [/attachment/wiki/XmlRpcPlugin/trac4r.tar.gz download the trac4r library] which does all the trivial stuff for you.
+
+This example uses trac4r:
+{{{
+#!ruby
+require 'trac4r/trac'
+# initialize the connection (username and password can be ommitted if not needed, but most of the time you will need them if anonymous doesn't have XMLRPC permissions)
+trac = Trac.new "https://dev.example.com/trac/my_awesome_project", "myusername", "mypassword"
+# get a list of all tickets (as an array of numbers)
+trac.tickets.list :include_closed => true # this is the default anyway
+# get all the tickets
+# NOTE: the results here are cached, so you can call it as often as you want without producing traffic more than once.
+# use ":cached_results => false" to get the latest version
+trac.tickets.get_all :include_closed => true
+# get a single ticket
+ticket = trac.tickets.get 5
+# print the data
+puts "Title: #{ticket.summary}"
+puts "Description: #{ticket.description}"
+puts "Milestone: #{ticket.milestone}"
+puts "Status: #{ticket.status}"
+puts "Type: #{ticket.type}"
+puts "Priority: #{ticket.priority}"
+# get a list of all wiki pages
+trac.wiki.list
+# download one page
+trac.wiki.get_html "SomeRandomPageName" # HTML version
+trac.wiki.get_raw "AnotherRandomPageName" # trac syntax version (e.g. for editing)
+# for previews use
+trac.wiki.raw_to_html "content of a page in [wiki:WikiFormatting Trac syntax] as a ''String''"
+# to post a page use
+trac.wiki.put "NameOfThePage", "content in Trac syntax"
+# list the attachments of a wiki page
+trac.wiki.attachments "NameOfThePage"
+# save an attachment
+File.new("my_cool_document","w") do |f|
+  f.write trac.wiki.get_attachment "NameOfThePage", "my_cool_document.pdf"
+end
+}}}
+
+Also see the included Documentation in trac4r/doc
+
+If you need to do a custom query do
+{{{
+#!ruby
+trac.query("system.getAPIVersion")
+}}}
+The first argument is the method name, all other arguments are directly passed to XMLRPC.
+For this example of cause you could do `trac.api_version` instead ;)
+
+If you have any problems with trac4r you can email me: niklas.cathor (eat) gmail dot com
+
 === API Usage ===