README.md in taskmapper-0.8.0 vs README.md in taskmapper-0.8.1

- old
+ new

@@ -1,22 +1,22 @@ -# taskmapper +# Taskmapper -taskmapper is a Gem which eases communication with various project and ticket management systems by providing a consistent Ruby API. +Taskmapper is a Gem which eases communication with various project and ticket management systems by providing a consistent Ruby API. -taskmapper let's you "remap" a system into the consistent taskmapper API, easily. For instance the description of an issue/ticket, might be named **description** in one system, and **problem-description** somewhere else. Via taskmapper, this would always be called **description**. The taskmapper remaps makes it easy for you to integrate different kinds of ticket systems, into your own system. You don't have to take care of all the different kinds of systems, and their different APIs. taskmapper handles all this *for* you, so you can focus on making your application awesome. +Taskmapper let's you "remap" a system into the consistent Taskmapper API, easily. For instance the description of an issue/ticket, might be named **description** in one system, and **problem-description** somewhere else. Via Taskmapper, this would always be called **description**. The Taskmapper remaps makes it easy for you to integrate different kinds of ticket systems, into your own system. You don't have to take care of all the different kinds of systems, and their different APIs. Taskmapper handles all this *for* you, so you can focus on making your application awesome. ## Installation -taskmapper is a Gem, so we can easily install it by using RubyGems: +Taskmapper is a Gem, so we can easily install it by using RubyGems: gem install taskmapper -taskmapper depends on [Hashie](http://github.com/intridea/hashie), which is an amazing library which makes converting objects to hashes, and the other way around, a joy. It should be installed automatically whenever installing taskmapper. +Taskmapper depends on [Hashie](http://github.com/intridea/hashie), which is an amazing library which makes converting objects to hashes, and the other way around, a joy. It should be installed automatically whenever installing taskmapper. ### Finding and installing a provider -taskmapper by itself won't do too much. You may want to install a provider, to retrieve a list of available providers issue the following command: +Taskmapper by itself won't do too much. You may want to install a provider, to retrieve a list of available providers issue the following command: gem search taskmapper You could then install for instance taskmapper-pivotal: @@ -30,34 +30,34 @@ pivotal = taskmapper.new(:pivotal, {:username => "john", :password => "seekrit"}) ### Grabbing a project -Now that we've got out taskmapper instance, let's go ahead and grab "testproject": +Now that we've got out Taskmapper instance, let's go ahead and grab "testproject": project = pivotal.project["testproject"] - #=> taskmapper::Project<#name="testproject"..> + #=> TaskMapper::Project<#name="testproject"..> *Project#[]* is an alias to *Project#find*: project = pivotal.project.find "testproject" - #=> taskmapper::Project<#name="testproject"..> + #=> TaskMapper::Project<#name="testproject"..> Which translates into: project = pivotal.project.find :name => "testproject" - #=> taskmapper::Project<#name="testproject"..> + #=> TaskMapper::Project<#name="testproject"..> That means you can actually look up a project by something else than the title, like the owner: project = pivotal.project.find :owner => "Sirupsen" - #=> taskmapper::Project<#owner="sirupsen"..> + #=> TaskMapper::Project<#owner="sirupsen"..> To retrieve all projects, simply pass no argument to find: project = pivotal.project.find - #=> [taskmapper::Project<#..>,TaskMapper::Project<#..>,..] + #=> [TaskMapper::Project<#..>,TaskMapper::Project<#..>,..] ### Creating a ticket Now that we grabbed the right project. Let's go ahead and create a ticket at this project: @@ -68,16 +68,16 @@ ### Finding tickets Alright, let's play with the projects tickets! Here we grab the ticket with the id of 22: ticket = project.tickets(:id => 22) - #=> taskmapper::Ticket<#id=22..> + #=> TaskMapper::Ticket<#id=22..> Like with projects, we can also find tickets by other attributes, like title, priority and so on, with tickets we do not use a find method though. Also as with projects, if no argument is passed, all tickets are retrieved: tickets = project.tickets - #=> [taskmapper::Ticket<#..>,TaskMapper::Ticket<#..>,..] + #=> [TaskMapper::Ticket<#..>,TaskMapper::Ticket<#..>,..] ### Changing ticket attributes Let's say that we're working on this ticket right now, so let's go ahead and change the status to reflect that: @@ -107,135 +107,122 @@ However, as closing a ticket with a resolution is such a common task, the other method is included because it may be more convenient. ## Support -Currently taskmapper supports the following systems: +Currently Taskmapper supports the following systems: ### Pivotal Tracker -To use Pivotal Tracker with taskmapper, install it: +To use Pivotal Tracker with Taskmapper, install it: gem install taskmapper-pivotal -Then simply require it, and you are good to use Pivotal Tracker with taskmapper! +Then simply require it, and you are good to use Pivotal Tracker with Taskmapper! require 'taskmapper' require 'taskmapper-pivotal' unfuddle = taskmapper.new(:pivotal, {:username => "..", :password => ".."}) The source code is located at [taskmapper-pivotal](http://github.com/hybridgroup/taskmapper-pivotal) ### Lighthouse -To use Lighthouse with taskmapper, install it: +To use Lighthouse with Taskmapper, install it: gem install taskmapper-lighthouse -Then simply require it, and you are all set to use Lighthouse with taskmapper! +Then simply require it, and you are all set to use Lighthouse with Taskmapper! require 'taskmapper' require 'taskmapper-lighthouse' lighthouse = taskmapper.new(:lighthouse, {:username => "..", :password => ".."}) The source code is located at [taskmapper-lighthouse](http://github.com/hybridgroup/taskmapper-lighthouse) ### Basecamp -To use Basecamp with taskmapper, install it: +To use Basecamp with Taskmapper, install it: gem install taskmapper-basecamp -Once you require it, then you are ready to use Basecamp with taskmapper +Once you require it, then you are ready to use Basecamp with Taskmapper require 'taskmapper' require 'taskmapper-basecamp' basecamp = taskmapper.new(:basecamp, :domain => 'yourdomain.basecamphq.com', :username => 'you', :password => 'pass') The source code is located at [taskmapper-basecamp](http://github.com/hybridgroup/taskmapper-basecamp) ### Github -To use Github's issue tracking with taskmapper, install it: +To use Github Issue tracking with Taskmapper, install it: gem install taskmapper-github -Once you require it, then you are ready to use Github and taskmapper +Once you require it, then you are ready to use Github and Taskmapper require 'taskmapper' require 'taskmapper-github' github = taskmapper.new(:github, :username => 'you', :password => 'pass') The source code is located at [taskmapper-github](http://github.com/hybridgroup/taskmapper-github) ### Unfuddle -To use Unfuddle with taskmapper, install it: +To use Unfuddle with Taskmapper, install it: gem install taskmapper-unfuddle -Then simply require it, and you are good to use Unfuddle with taskmapper! +Then simply require it, and you are good to use Unfuddle with Taskmapper! require 'taskmapper' require 'taskmapper-unfuddle' unfuddle = taskmapper.new(:unfuddle, {:username => "..", :password => "..", :account => ".."}) The source code is located at [taskmapper-unfuddle](http://github.com/hybridgroup/taskmapper-unfuddle) -### Kanban Pad +### Kanbanpad -To use Kanban Pad with taskmapper, install it: +To use Kanbanpad with taskmapper, install it: gem install taskmapper-kanbanpad -Once you require it, you can connect to Kanban Pad using taskmapper! +Once you require it, you can connect to Kanbanpad using Taskmapper! require 'taskmapper' require 'taskmapper-kanbanpad' kanbanpad = taskmapper.new(:kanbanpad, {:username => "xx", :password => "xx"}) The source code is located at [taskmapper-kanbanpad](https://github.com/hybridgroup/taskmapper-kanbanpad) ### Redmine -To use Redmine with taskmapper, install it: +To use Redmine with Taskmapper, install it: gem install taskmapper-redmine -Just require it, and you are ready to use Redmine with taskmapper! +Just require it, and you are ready to use Redmine with Taskmapper! require 'taskmapper' require 'taskmapper-redmine' redmine = taskmapper.new(:redmine, {:username => "..", :password => "..", :server => ".."}) The source code is located at [taskmapper-redmine](http://github.com/hybridgroup/taskmapper-redmine) ### Trac -To use Trac with taskmapper, install it: +To use Trac with Taskmapper, install it: gem install taskmapper-trac -Require it, and you are happening to call Trac with taskmapper! +Require it, and you are happening to call Trac with Taskmapper! require 'taskmapper' require 'taskmapper-trac' trac = taskmapper.new(:trac, {:username => "..", :password => "..", :url => ".."}) The source code is located at [taskmapper-trac](http://github.com/hybridgroup/taskmapper-trac) -### Codaset - -To use Codaset with taskmapper, install it: - gem install taskmapper-codaset - -Require and you have connected to Codaset with taskmapper! - - require 'taskmapper' - require 'taskmapper-codaset' - codaset = taskmapper.new(:codaset, {:username => "foo", :password => "bar", :client_id => "your_client_id", :client_secret => "your_client_secret"}) - -The source code is located at [taskmapper-codaset](http://github.com/hybridgroup/taskmapper-codaset) - ### Bugzilla -To use Bugzilla with taskmapper, install it: +To use Bugzilla with Taskmapper, install it: gem install taskmapper-bugzilla -Require and you can talk to Bugzilla with taskmapper! +Require and you can talk to Bugzilla with Taskmapper! require 'taskmapper' require 'taskmapper-bugzilla' codaset = taskmapper.new(:bugzilla, {:username => "foo", :password => "bar", :url => "https://bugzilla.mozilla.org"}) @@ -247,22 +234,22 @@ * Run the generator like this: tm generate myprovider * Implement whatever is needed to connect to your desired backend * Release it to RubyGems -### Create the taskmapper provider +### Create the Taskmapper provider Thanks to a simple generator, it is easy to get started with a new provider. Run this from the command line: tm generate myprovider This will generate a new skeleton provider called taskmapper-myprovider in the current directory. Create a repo from that directory, and you can start implementing your provider. -Almost all APIs are different. And so are their Ruby providers. taskmapper attempts to create an universal API for ticket and project management systems, and thus, we need to map the functionality to the taskmapper API. This is the providers job. The provider is the glue between taskmapper, and the ticket management system's API. +Almost all APIs are different. And so are their Ruby providers. Taskmapper attempts to create an universal API for ticket and project management systems, and thus, we need to map the functionality to the Taskmapper API. This is the providers job. The provider is the glue between Taskmapper, and the task management system's API. Usually, your provider would rely on another library for the raw HTTP interaction. For instance, [taskmapper-lighthouse](http://github.com/hybridgroup/taskmapper-lighthouse) relies on ActiveResource in order to interact with the Lighthouse API. Look at it like this: -**taskmapper** -> **Provider** -> *(Ruby library)* -> **Site's API** +**Taskmapper** -> **Provider** -> *(Ruby library)* -> **Site's API** -Provider being the *glue* between the site's API and taskmapper. The Ruby library is "optional" (though highly recommended as mentioned), therefore it is in parantheses. +Provider being the *glue* between the site's API and Taskmapper. The Ruby library is "optional" (though highly recommended as mentioned), therefore it is in parantheses. An example of a provider could be [taskmapper-lighthouse](http://github.com/hybridgroup/taskmapper-lighthouse), an example of a Ruby library could be ActiveResource. For now, look at [taskmapper-lighthouse](http://github.com/hybridgroup/taskmapper-lighthouse) as an example on how to create a provider. More detailed documentation will be available soon. @@ -291,6 +278,6 @@ (if you want to have your own version, that is fine but bump version in a commit by itself so we can ignore when we pull) * Send us a pull request. Bonus points for feature branches. ## Copyright -Copyright (c) 2010 [The Hybrid Group](http://hybridgroup.com). See LICENSE for details. +Copyright (c) 2010-2012 [The Hybrid Group](http://hybridgroup.com). See LICENSE for details.