ruby-fogbugz 0.0.3 → 0.0.4

data/README.md

@@ -1,5 +1,64 @@
 # ruby-fogbugz
 
-Readme coming soon to a repo near you.
+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.
 
-For now, check out [Foghub](https://github.com/firmafon/foghub) where this was extracted from for usage.
+# Installation
+
+    gem install ruby-fogbugz
+
+```ruby
+["mri-1.9,2", "mri-1.8.7", "rbx-1.2.4", "rbx-2.0.0", "jruby-1.6.2"].all? { |implementation| implementation.works? }
+# => true
+```
+
+# 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 'rubygems'
+require 'fogbugz'
+require 'pp'
+
+fogbugz = Fogbugz::Interface.new(:email => 'my@email.com', :password => 'seekrit', :uri => 'https://company.fogbugz.com') # remember to use https!
+fogbugz.authenticate # token is not automatically attached to every future requests
+pp fogbugz.command(:listPeople)
+```
+
+[fad]:http://fogbugz.stackexchange.com/fogbugz-xml-api
+
+# License
+
+`ruby-fogbugz` is released under the MIT license.

data/lib/ruby_fogbugz/interface.rb

@@ -8,7 +8,7 @@ module Fogbugz
     def initialize(options = {})
       @options = {}.merge(options)
 
-      raise InitializationError, "Must supply URI (e.g. http://fogbugz.company.com)" unless options[:uri]
+      raise InitializationError, "Must supply URI (e.g. https://fogbugz.company.com)" unless options[:uri]
       @http = Fogbugz.adapter[:http].new(:uri => options[:uri])
       @xml = Fogbugz.adapter[:xml]
     end

data/lib/ruby_fogbugz/version.rb

@@ -1,3 +1,3 @@
 module Fogbugz
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-fogbugz
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - "Simon H\xC3\xB8rup Eskildsen"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-26 00:00:00 +02:00
+date: 2011-07-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency