taskmapper-lighthouse 0.9.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "taskmapper", "~> 0.8"
+gem "xml-simple", "~> 1.1"
+gem "addressable", "~> 2.2"
+gem "lighthouse-api", "~> 2.0"
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8"
+  gem "jeweler", "~> 1.6"
+  gem "simplecov", "~> 0.5", :platforms => :ruby_19
+  gem "rcov", "~> 1.0", :platforms => :ruby_18
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activeresource (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.7)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    hashie (1.2.0)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    lighthouse-api (2.0)
+      activeresource (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rcov (1.0.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.5.4)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    taskmapper (0.8.0)
+      activeresource (~> 3.0)
+      activesupport (~> 3.0)
+      hashie (~> 1.2)
+    xml-simple (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  addressable (~> 2.2)
+  jeweler (~> 1.6)
+  lighthouse-api (~> 2.0)
+  rcov (~> 1.0)
+  rspec (~> 2.8)
+  simplecov (~> 0.5)
+  taskmapper (~> 0.8)
+  xml-simple (~> 1.1)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009-2010 The Hybrid Group
+
+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:
+
+NONE
+
+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.

data/README.md

@@ -0,0 +1,54 @@
+# taskmapper-lighthouse
+
+This is a provider for [taskmapper](http://ticketrb.com). It provides interoperability with [Lighthouse](http://www.lighthouseapp.com/) through the taskmapper gem.
+
+# Usage and Examples
+
+First we have to instantiate a new taskmapper instance:
+
+    lighthouse = TaskMapper.new(:lighthouse, {:subdomain => "rails"})
+    lighthouse = TaskMapper.new(:lighthouse, {:username => "code", :password => "m4st3r!", :account => "taskmapper"})
+    lighthouse = TaskMapper.new(:lighthouse, {:token => "5ff546af3df4a3c02d3a719b0ff1c3fcc5351c97", :account => "lhdemo"})
+
+The :account is the name of the account which should be the same as the subdomain used to access the account's projects. For you convenience, you can also pass in :subdomain in place of :account. If you pass in both, it'll use the :account value. If you do not pass in the token or both the username and password, it will only access public information for the account.
+
+Tokens allow access to a specific project or account without having to give out your login credentials. It can be nullified if necessary. I highly suggest you use tokens. For more information, please see Lighthouse's FAQ [How do I get an API token?](http://help.lighthouseapp.com/faqs/api/how-do-i-get-an-api-token)
+
+== Finding Projects
+
+    project = lighthouse.project['project_name']
+    project = lighthouse.project.find(:id => 505)
+
+== Finding Tickets
+
+    tickets = project.tickets
+    
+
+## Requirements
+
+* rubygems (obviously)
+* taskmapper gem (latest version preferred)
+* jeweler gem (only if you want to repackage and develop)
+
+The taskmapper gem should automatically be installed during the installation of this gem if it is not already installed.
+
+## Other Notes
+
+Since this and the taskmapper gem is still primarily a work-in-progress, minor changes may be incompatible with previous versions. Please be careful about using and updating this gem in production.
+
+If you see or find any issues, feel free to open up an issue report.
+
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 The Hybrid Group. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "taskmapper-lighthouse"
+    gem.summary = %Q{TaskMapper Provider for Lighthouse}
+    gem.description = %Q{Allows taskmapper to interact with Lighthouse's issue tracking system.}
+    gem.email = "hong.quach@abigfisch.com"
+    gem.homepage = "http://github.com/kiafaldorius/taskmapper-lighthouse"
+    gem.authors = ["Hong"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "taskmapper-kanbanpad#{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/provider/comment.rb

@@ -0,0 +1,85 @@
+module TaskMapper::Provider
+  module Lighthouse
+    # The comment class for taskmapper-lighthouse
+    #
+    # Due to the way lighthouse handles tickets, comments aren't really comments, but
+    # versions of the ticket.
+    #
+    # * author => user_name (read-only)
+    # * body => description
+    # * id => position in the versions array (set by the initializer)
+    # * created_at
+    # * updated_at
+    # * ticket_id => number (read-only)
+    # * project_id => (set by the initializer)
+    class Comment < TaskMapper::Provider::Base::Comment
+      API = ::Lighthouse::Ticket
+      
+      # A custom find_by_id
+      # The "comment" id is it's index in the versions array. An id of 0 therefore exists and
+      # should be the first ticket (original)
+      def self.find_by_id(project_id, ticket_id, id)
+        self.new API.find(ticket_id, :params => {:project_id => project_id}), id
+      end
+
+      # A custom find_by_attributes
+      #
+      def self.find_by_attributes(project_id, ticket_id, attributes = {})
+        result = self.search(project_id, ticket_id, attributes)
+        result[0].shift
+        result[0].collect do |comment|
+          self.new(result[1], index_of(result[1].versions, comment)) if !comment.body.blank?
+        end.compact
+      end
+
+      # The Array#index method doesn't work for the versions...
+      # because it seems they're all equal.
+      def self.index_of(versions, needle)
+        result = nil
+        versions.each_with_index do |version, index|
+          result = index if version.attributes == needle.attributes
+        end
+        result
+      end
+
+      def self.create(*options)
+        attributes = options.first
+        ticket_id = attributes.delete(:ticket_id) || attributes.delete('ticket_id')
+        project_id = attributes.delete(:project_id) || attributes.delete('project_id')
+        ticket = self::API.find(ticket_id, :params => {:project_id => project_id})
+        attributes.each do |k, v|
+          ticket.send("#{k}=", v)
+        end
+        versions = ticket.attributes.delete('versions')
+        ticket.save
+        ticket.attributes['versions'] = versions
+        self.find_by_id project_id, ticket_id, ticket.versions.length
+      end
+
+      def initialize(ticket, id)
+        @system_data ||= {}
+        return super(ticket) unless ticket.respond_to?('versions') and ticket.versions.respond_to?('[]')
+        @system_data[:ticket] = @system_data[:client] = ticket
+        @system_data[:version] = ticket.versions[id] 
+        self.project_id = ticket.prefix_options[:project_id] 
+        self.id = id
+        super(@system_data[:version].attributes) 
+      end
+
+      # A custom searcher
+      #
+      # It returns a custom result because we need the original ticket to make a comment.
+      def self.search(project_id, ticket_id, options = {}, limit = 1000)
+        ticket = API.find(ticket_id, :params => {:project_id => project_id})
+        comments = ticket.versions
+        [search_by_attribute(comments, options, limit), ticket]
+      end
+
+      # The author's name
+      def author
+        user_name
+      end
+
+    end
+  end
+end

data/lib/provider/lighthouse.rb

@@ -0,0 +1,77 @@
+module TaskMapper::Provider
+  # This is the Lighthouse Provider for taskmapper
+  module Lighthouse
+    include TaskMapper::Provider::Base
+    PROJECT_API = ::Lighthouse::Project
+    TICKET_API = ::Lighthouse::Ticket
+    
+    # This is for cases when you want to instantiate using TaskMapper::Provider::Lighthouse.new(auth)
+    def self.new(auth = {})
+      TaskMapper.new(:lighthouse, auth)
+    end
+    
+    # The authorize and initializer for this provider
+    def authorize(auth = {})
+      @authentication ||= TaskMapper::Authenticator.new(auth)
+      auth = @authentication
+      if auth.account.nil? or (auth.token.nil? and (auth.username.nil? and auth.password.nil?))
+        raise "Please provide at least an account (subdomain) and token or username and password)"
+      end
+      ::Lighthouse::Base.format = :json
+      ::Lighthouse.account = auth.account || auth.subdomain
+      if auth.token
+        ::Lighthouse.token = auth.token
+      elsif auth.username && auth.password
+        ::Lighthouse.authenticate(auth.username, auth.password)
+      end
+    end
+
+    def valid?
+      begin
+        PROJECT_API.find(:first)
+        true
+      rescue
+        false
+      end
+    end
+
+    # The projects
+    #
+    # We have to merge in the auth information because, due to the class-based authentication
+    # mechanism, if we don't reset the authorize information for every request, it would 
+    # end up using whatever the previous instantiated object's account info is.
+    def projects(*options)
+      authorize
+      super(*options)
+    end
+
+    # The project
+    def project(*options)
+      authorize
+      super(*options)
+    end
+
+    # The tickets
+    #
+    # Due to the nature of lighthouse, we must have the project_id to pull tickets. You can
+    # pass in the id through this format:
+    # 
+    #    .tickets(22)
+    #    .tickets(:project_id => 22)
+    # 
+    # To conform to taskmapper's standard of returning all tickets on a call to this method
+    # without any parameters, if no parameters are passed, it will return all tickets for whatever
+    # the first project is.
+    def tickets(*options)
+      authorize
+      super(*options)
+    end
+
+    # the ticket
+    def ticket(*options)
+      authorize
+      super(*options)
+    end
+
+  end
+end

data/lib/provider/project.rb

@@ -0,0 +1,28 @@
+module TaskMapper::Provider
+  module Lighthouse
+    # Project class for taskmapper-lighthouse
+    # 
+    # 
+    class Project < TaskMapper::Provider::Base::Project
+      attr_accessor :prefix_options
+      API = ::Lighthouse::Project  
+      # Delete this project
+      def destroy
+        result = super
+        result.is_a?(Net::HTTPOK)
+      end
+      
+      # copy from this.copy(that) copies that into this
+      def copy(project)
+        project.tickets.each do |ticket|
+          copy_ticket = self.ticket!(:title => ticket.title, :description => ticket.description)
+          ticket.comments.each do |comment|
+            copy_ticket.comment!(:body => comment.body)
+            sleep 1
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/provider/ticket.rb

@@ -0,0 +1,153 @@
+module TaskMapper::Provider
+  module Lighthouse
+    # Ticket class for taskmapper-lighthouse
+    #
+    # Due to the way Lighthouse stores tickets, we actually end up creating a new ticket version
+    # every time we edit tickets. Their api FAQ states these attributes as the only editable ones(?):
+    #
+    # * title
+    # * body - follows the same formatting rules.
+    # * state - Can be any one of these: new, open, resolved, hold, invalid. Optional, set to open by default for new tickets.
+    # * assigned-user-id - optional
+    # * milestone-id - optional
+    # * tag - space or comma delimited list of tags
+    #
+    # We had to remap things a bit since lighthouse doesn't name things as taskmapper specifies.
+    #
+    # * id => number (read-only)
+    # * status => state
+    # * resolution => ticket.latest_body
+    # * description => ticket.original_body (setting a new description creates a new body)
+    # * assignee => assigned_user_name (read-only)
+    # * requestor => creator_name (read-only)
+    # * project_id => prefix_options[:project_id]
+    # * priority
+    # * title
+    # * created_at
+    # * updated_at
+
+    class Ticket < TaskMapper::Provider::Base::Ticket
+      @@allowed_states = ['new', 'open', 'resolved', 'hold', 'invalid']
+      attr_accessor :prefix_options
+      API = ::Lighthouse::Ticket
+
+      # This is to get the ticket id
+      # We can't set ids, so there's no 'id=' method.
+      def id
+        @system_data[:client].number
+      end
+
+      # This is to get the status, mapped to state
+      def status
+        state
+      end
+
+      # This is to set the status, mapped to state
+      def status=(stat)
+        stat = state unless @@allowed_states.include?(stat)
+        self.state = stat
+      end
+
+      # Get the resolution, mapped to latest_body
+      def resolution
+        self.latest_body
+      end
+
+      # Set the resolution...also sets state to resolved
+      def resolution=(res)
+        state = 'resolved'
+        self.body = res
+      end
+
+      # Get the description, mapped to original_body
+      def description
+        self.original_body
+      end
+
+      # Set the description, mapped to body, which actually does a comment
+      def description=(desc)
+        self.body = desc
+      end
+
+      # Get the assigned person's name
+      def assignee
+        self.assigned_user_name
+      end
+
+      # Get the requestor's name
+      def requestor
+        self.creator_name
+      end
+
+      # Get the project id
+      def project_id
+        prefix_options[:project_id]
+      end
+
+      # Set the body
+      def body=(bod)
+        @system_data[:client].body = nil
+        super(bod)
+      end
+
+      # Tags, a little helper for the ticket tagging
+      def tags
+        return @tags if @tags
+        tagz = self.tag.split(/([\w\d]+)|"([\w \d]+)"/)
+        tagz.delete(' ')
+        tagz.delete('')
+        @tags = tagz
+      end
+
+      # Gotta unset the body attribute...otherwise every save ends up using that body
+      def save
+#        self.tag = @tags.reduce([]) do |mem, t|
+#          t = "\"#{t}\"" if t.include?(' ')
+#          mem << t
+#        end.join(' ') if @tags
+        @system_data[:client].attributes.delete('versions')
+        result = super
+        body = nil
+        @system_data[:client].body = nil
+        result
+      end
+
+      # The closer
+      def close(resolution = 'resolved')
+        resolution = 'resolved' unless @@allowed_states.include?(resolution)
+        ticket = ::Lighthouse::Ticket.find(self.id, :params => {:project_id => self.prefix_options[:project_id]})
+        ticket.state = resolution
+        ticket.save
+      end
+
+      class << self
+
+        def create(options)
+          super translate options,
+            :description => :body,
+            :status => :state,
+            :assignee => :assigned_user_id
+        end
+
+        # Lighthouse limits us to a 100 ticket limit per page...
+        # Since the paging sucks...we probably want to store this rather than do a call each time
+        def search(project_id, options = {}, limit = 1000)
+          page = 1
+          tickets = ::Lighthouse::Ticket.find(:all, :params => {:project_id => project_id, :limit => 100, :page => page})
+          result = []
+          while tickets.length > 0 and page <= 3 #limit to page 3 since lighthouse is so slow...
+            result += tickets.collect { |ticket| self.new ticket }
+            page += 1
+            tickets = ::Lighthouse::Ticket.find(:all, :params => {:project_id => project_id, :limit => 100, :page => page})
+          end
+          search_by_attribute(result, options, limit)
+        end
+
+        private
+          def translate(hash, mapping)
+            Hash[hash.map { |k, v| [mapping[k] ||= k, v]}]
+          end
+      end
+    end
+  end
+end