liquidplanner 0.0.2 → 0.0.3

data/HISTORY

@@ -1,3 +1,11 @@
 0.0.1
 -----
-Initial release
+* Initial release
+
+0.0.2
+-----
+* Ensure non beta ActiveResource libraries are used
+
+0.0.3
+-----
+* Updated for LiquidPlanner 3.0

data/examples/README

@@ -1,14 +1,27 @@
-All of the examples expect you to pass in your account name and workspace id, 
+Command Line Examples:
+======================
+
+Files: create_task.rb, list_tasks.rb, track_time.rb
+
+All of these examples expect you to pass in your account name and workspace id, 
 for instance:
 
-  ruby examples/list_tasks.rb alice@example.com 7
+    ruby examples/list_tasks.rb alice@example.com 7
   
 If you set the VERBOSE environment variable, the examples will print out their
 http requests to the console:
 
-  ruby examples/list_tasks.rb alice@example.com 7 --verbose
+    ruby examples/list_tasks.rb alice@example.com 7 --verbose
   
 These examples all use highline library for prompting the user.  Install the 
 gem with:
 
-  sudo gem install highline
+    sudo gem install highline
+
+Source Control Management Examples:
+===================================
+
+Files: post-commit.rb, svn-post-commit.sh
+
+This is a working example of integrating LiquidPlanner with SVN. See 
+post-commit.rb for more information.

data/examples/create_task.rb

@@ -13,6 +13,11 @@ email, password, space_id = get_credentials!
 lp = LiquidPlanner::Base.new(:email=>email, :password=>password)
 workspace = lp.workspaces(space_id)
 
+unless parent = workspace.packages(:first) || workspace.projects(:first)
+  say "There are no packages or projects in this workspace; cannot add a task."
+  exit
+end
+
 # Ask for a task's name and estimate
 say "Add a new task to '#{workspace.name}'"
 name  = ask("New task name")
@@ -21,8 +26,8 @@ high  = ask("Max effort", Float){|q| q.above = low}
 
 # Submit the task and estimate
 say "Submitting: '#{name}' [#{low} - #{high}] to LiquidPlanner"
-task = workspace.create_task(:name=>name)
+task = workspace.create_task(:name=>name, :parent_id => parent.id)
 task.create_estimate(:low=>low, :high=>high)
 
 # All done
-say "Added task"
+say "Added task"

data/examples/post-commit.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+#
+# This script is intended as a commit (or check-in, push, etc.) message
+# processor with your SCM (Subversion, git, etc.) of choice. It scans the
+# message for link(s) to tasks in LiquidPlanner, and creates a comment
+# on each such task containing the text of the commit message.
+#
+# == Prerequisites
+#
+# You'll need a LiquidPlanner account and the liquidplanner gem.
+#
+# == Usage
+#
+# The script takes a single command-line parameter, which is the path to a
+# YAML config file containing your LiquidPlanner credentials.
+#
+# So, you might create a post-commit.yml file containing:
+#   
+#   email:    your_email_address@example.com
+#   password: your_liquidplanner_password
+#
+# Then you pass the commit message to the script on its standard input.
+#
+# Initially, try placing a test message (containing at least one link to a
+# task in your LiquidPlanner workspace) in a file named commit_message.txt.
+# Then run a command:
+#
+#   cat commit_message.txt | ruby ./post-commit.rb post-commit.yml
+#
+# This should create a comment on the linked task.
+#
+# == Integrating with your SCM
+#
+# Now it's just a matter of invoking this script on each commit to your SCM.
+#
+# Refer to the docs for your system of choice; we've included an example for
+# Subversion in svn-post-commit.sh
+#
+
+require 'rubygems'
+require 'liquidplanner'
+require 'cgi'
+
+class LiquidPlannerCommitMessenger
+
+  # pattern for identifying task IDs in the message; this matches URLs copied
+  # from LiquidPlanner, but you could choose to adopt a more compact notation
+  # and modify this pattern accordingly
+  #
+  LINK_PATTERN = %r{https://app.liquidplanner.com/space/([0-9]+)/[^\/]+/show\?id=([0-9]+)}
+
+  def initialize(email, password)
+    @lp = LiquidPlanner::Base.new(:email => email, :password => password) 
+  end
+
+  # scan the message for one or more links to a LiquidPlanner task; for each
+  # such link, create a comment on the referenced task containing the text of
+  # the message
+  def process_commit_message(message)
+    comment = convert_message_to_comment(message)
+    message.scan(LINK_PATTERN) do |space_id, task_id|
+      add_comment(space_id, task_id, comment)
+    end
+  end
+
+  protected
+
+  # create a comment on the given task in the given space,
+  # if they exist
+  def add_comment(space_id, task_id, comment)
+    if space = @lp.workspaces(space_id)
+      if task = space.tasks(task_id)
+        task.create_comment(:comment => comment)
+      end
+    end
+  end
+
+  # convert the commit message to HTML comment
+  def convert_message_to_comment(message)
+    # escape HTML, so that it can be read as comment text rather than
+    # interpreted as markup
+    m = CGI::escapeHTML(message)
+
+    # compress runs of newlines, and convert to br tags
+    m = m.gsub(/([\r?\n\r?]){3,}/, "\n\n").gsub(/\r?\n\r?/, "<br/>")
+
+    m
+  end
+
+end
+
+if $0 == __FILE__
+
+  config = YAML.load(File.read(ARGV[0]))
+  email    = config["email"]
+  password = config["password"]
+
+  message = STDIN.read
+  LiquidPlannerCommitMessenger.new(email, password).process_commit_message(message)
+
+end
+

data/examples/svn-post-commit.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+#
+# simple SVN post-commit hook to LiquidPlanner
+#
+PATH=/usr/local/bin:/usr/bin
+
+REPO="$1"
+REV="$2"
+
+svn log -r $REV $REPO | ./post-commit.rb post-commit.yml
+

data/lib/liquidplanner.rb

@@ -2,7 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module LiquidPlanner
-  VERSION      = "0.0.2"
+  VERSION      = "0.0.3"
   API_BASE_URL = "https://app.liquidplanner.com/api"
 end
 
@@ -20,17 +20,18 @@ require "liquidplanner/resources/account"
 require "liquidplanner/resources/member"
 require "liquidplanner/resources/workspace"
 
-require "liquidplanner/resources/relative_resource"
-require "liquidplanner/resources/priority"
-require "liquidplanner/resources/order"
+require "liquidplanner/resources/move_or_package"
+require "liquidplanner/resources/movable"
+require "liquidplanner/resources/packageable"
 
-require "liquidplanner/resources/item"
+require "liquidplanner/resources/treeitem"
 require "liquidplanner/resources/container"
 require "liquidplanner/resources/leaf"
+require "liquidplanner/resources/root"
 require "liquidplanner/resources/task"
 require "liquidplanner/resources/event"
 require "liquidplanner/resources/milestone"
-require "liquidplanner/resources/tasklist"
+require "liquidplanner/resources/package"
 require "liquidplanner/resources/folder"
 require "liquidplanner/resources/project"
 require "liquidplanner/resources/client"
@@ -46,4 +47,4 @@ require "liquidplanner/resources/activity"
 
 require "liquidplanner/ext/hash"
 require "liquidplanner/ext/connection"
-require "liquidplanner/ext/exceptions"
+require "liquidplanner/ext/exceptions"

data/lib/liquidplanner/debug.rb

@@ -1,7 +1,7 @@
 module LiquidPlanner
   # Print out all the outgoing requests from the LiquidPlanner API
   def self.watch_requests!(&block)
-    ActiveSupport::Notifications.subscribe('active_resource.request') do |name, time, stamp, id, payload|
+    ActiveSupport::Notifications.subscribe('request.active_resource') do |name, time, stamp, id, payload|
       method = payload[:method]
       request = payload[:request_uri]
       

data/lib/liquidplanner/liquidplanner_resource.rb

@@ -13,6 +13,10 @@ module LiquidPlanner
       @prefix_options.merge!(initial_prefix_options){|k, old_attr,new_attr| old_attr || new_attr }
       self
     end
+
+    def get_raw(custom_method_name, options = {})
+      connection.get_raw(custom_method_element_url(custom_method_name, options), self.class.headers)
+    end
     
     private
     # Override the default instantiate_record to support polymorphic types
@@ -41,7 +45,7 @@ module LiquidPlanner
     #   workspace.create_task(:name=>'new task').create_estimate(:low_effort=>1, :high_effort=>3)
     def method_missing(name, *args)
       if name.to_s =~ /^(create|build)_(.+)/
-        operation    = $1.to_sym
+        operation   = $1.to_sym
         resource    = $2
         attributes  = args.shift || {}
         klass = LiquidPlanner::Resources.const_get(resource.classify)

data/lib/liquidplanner/resources/client.rb

@@ -1,7 +1,6 @@
 module LiquidPlanner
   module Resources
-    class Client < Container
-      include Order
+    class Client < Treeitem
     end
   end
 end

data/lib/liquidplanner/resources/container.rb

@@ -1,6 +1,7 @@
 module LiquidPlanner
   module Resources
-    class Container < Item
+    class Container < Treeitem
+      include Movable
     end
   end
 end

data/lib/liquidplanner/resources/document.rb

@@ -29,10 +29,6 @@ module LiquidPlanner
         end
       end
 
-      def get_raw(custom_method_name, options = {})
-        connection.get_raw(custom_method_element_url(custom_method_name, options), self.class.headers)
-      end
-
       def download
         get_raw(:download)
       end

data/lib/liquidplanner/resources/folder.rb

@@ -1,7 +1,6 @@
 module LiquidPlanner
   module Resources
     class Folder < Container
-      include Order
     end
   end
 end

data/lib/liquidplanner/resources/leaf.rb

@@ -1,18 +1,22 @@
 #------------------------------------------------------------------------
 # leaves
 #------------------------------------------------------------------------
-
 module LiquidPlanner
   module Resources
-    class Leaf < Item
-      include Priority
-      include Order
+    class Leaf < Treeitem
+      include Movable
+      include Packageable
 
       TRACK_TIME_KEYS = [ :work, :activity_id, :member_id, :low, :high, :is_done, :done_on, :work_performed_on, :comment ].freeze
       def track_time( options={} )
         options.assert_valid_keys( *TRACK_TIME_KEYS )
         request_body = options.to_json
-        response = post(:track_time, {}, request_body)
+        # ActiveResource post() by default:
+        #   response = post(:track_time, {}, request_body) 
+        # will set this route with 'new': /api/workspaces/36/tasks/new/activities.json
+        # it's because of how it sets @persisted = true by default, calling custom_method_new_element_url()
+        # what we want is: /api/workspaces/36/tasks/:id/activities.json, which is accomplished here:
+        response = connection.post(custom_method_element_url(:track_time, options), request_body)
         load( self.class.format.decode( response.body ) )
       end
 

data/lib/liquidplanner/resources/member.rb

@@ -2,6 +2,9 @@ module LiquidPlanner
   module Resources
     class Member < LiquidPlanner::LiquidPlannerResource
       self.prefix = "/api/workspaces/:workspace_id/"
+      def avatar
+        get_raw(:avatar)
+      end
     end
   end
 end

data/lib/liquidplanner/resources/movable.rb

@@ -0,0 +1,13 @@
+module LiquidPlanner
+  # For resources that can be moved
+  module Movable
+    include MoveOrPackage
+    def move_before(item, is_packaged_other=false)
+      move_or_package :move, :before, item, is_packaged_other
+    end
+  
+    def move_after(item, is_packaged_other=false)
+      move_or_package :move, :after, item, is_packaged_other
+    end
+  end
+end

data/lib/liquidplanner/resources/move_or_package.rb

@@ -0,0 +1,23 @@
+module LiquidPlanner
+  module MoveOrPackage
+    def move_or_package(motion, relative, other, is_packaged_other=false)
+
+      raise ArgumentError.new("motion must be move or package")   unless [:move, :package].include?(motion)
+      raise ArgumentError.new("relative must be before or after") unless [:before, :after].include?(relative)
+      action = "#{motion}_#{relative}"
+
+      other_id = other.is_a?(LiquidPlanner::LiquidPlannerResource) ? other.id : other
+
+      params = {}
+      if is_packaged_other && :move == motion
+        params[:packaged_other_id] = other_id
+      else
+        params[:other_id] = other_id
+      end
+
+      response = post(action, params)
+
+      load( self.class.format.decode( response.body ) )
+    end
+  end
+end

data/lib/liquidplanner/resources/{tasklist.rb → package.rb}

@@ -1,7 +1,7 @@
 module LiquidPlanner
   module Resources
-    class Tasklist < Container
-      include Priority
+    class Package < Container
+      include Movable
     end
   end
 end

data/lib/liquidplanner/resources/packageable.rb

@@ -0,0 +1,13 @@
+module LiquidPlanner
+  # For resources that can be packaged
+  module Packageable
+    include MoveOrPackage
+    def package_before(item)
+      move_or_package :package, :before, item
+    end
+  
+    def package_after(item)
+      move_or_package :package, :after, item
+    end
+  end
+end

data/lib/liquidplanner/resources/project.rb

@@ -1,7 +1,6 @@
 module LiquidPlanner
   module Resources
-    class Project < Item
-      include Order
+    class Project < Container
     end
   end
 end

data/lib/liquidplanner/resources/root.rb

@@ -0,0 +1,6 @@
+module LiquidPlanner
+  module Resources
+    class Root < Container
+    end
+  end
+end

data/lib/liquidplanner/resources/{item.rb → treeitem.rb}

@@ -3,16 +3,24 @@
 #------------------------------------------------------------------------
 module LiquidPlanner
   module Resources
-    class Item < LiquidPlanner::LiquidPlannerResource
+    class Treeitem < LiquidPlanner::LiquidPlannerResource
 
       self.prefix = "/api/workspaces/:workspace_id/"
 
-      def folder
-        Folder.find( :one, :from => "/api/workspaces/#{workspace_id}/folders/#{folder_id}" )
+      def parent
+        parent_id && Treeitem.find( :one, :from => "/api/workspaces/#{workspace_id}/treeitems/#{parent_id}" )
       end
 
-      def tasklist
-        Tasklist.find( :one, :from => "/api/workspaces/#{workspace_id}/tasklists/#{tasklist_id}" )
+      def package
+        package_id && Package.find( :one, :from => "/api/workspaces/#{workspace_id}/packages/#{package_id}" )
+      end
+
+      def project
+        project_id && Project.find( :one, :from => "/api/workspaces/#{workspace_id}/projects/#{project_id}" )
+      end
+
+      def client
+        client_id && Client.find( :one, :from => "/api/workspaces/#{workspace_id}/clients/#{client_id}" )
       end
 
       def note
@@ -20,7 +28,11 @@ module LiquidPlanner
           n.prefix_options = luggage_params
         end
       end
-
+      
+      def activities( scope=:all )
+        Activity.find( scope, :params => luggage_params )
+      end
+      
       def comments( scope=:all )
         Comment.find( scope, :params => luggage_params )
       end

data/lib/liquidplanner/resources/workspace.rb

@@ -6,19 +6,40 @@ module LiquidPlanner
         Member.find( scope, :params => { :workspace_id => self.id }.merge(options) )
       end
 
+      def treeitems( scope=:all, options={} )
+        Treeitem.find( scope, :params => { :workspace_id => self.id, :flat => true }.merge(options) )
+      end
+
       def tasks( scope=:all, options={} )
         Task.find( scope, :params => { :workspace_id => self.id }.merge(options) )
       end
 
-      def folders( scope=:all, options={} )
-        Folder.find( scope, :params => { :workspace_id => self.id, :flat => true }.merge(options) )
+      def events( scope=:all, options={} )
+        Event.find( scope, :params => { :workspace_id => self.id }.merge(options) )
+      end
+
+      def milestones( scope=:all, options={} )
+        Milestone.find( scope, :params => { :workspace_id => self.id }.merge(options) )
+      end
+
+      def clients( scope=:all, options={} )
+        Client.find( scope, :params => { :workspace_id => self.id, :flat => true }.merge(options) )
       end
 
-      def tasklists( scope=:all, options={} )
-        Tasklist.find( scope, :params => { :workspace_id => self.id, :flat => true }.merge(options) )
+      def projects( scope=:all, options={} )
+        Project.find( scope, :params => { :workspace_id => self.id, :flat => true }.merge(options) )
+      end
+
+      def packages( scope=:all, options={} )
+        Package.find( scope, :params => { :workspace_id => self.id, :flat => true }.merge(options) )
+      end
+
+      def folders( scope=:all, options={} )
+        Folder.find( scope, :params => { :workspace_id => self.id, :flat => true }.merge(options) )
       end
             
-    protected
+      protected
+
       # create a new instance of klass (Task, Folder, etc.),
       # with the workspace_id set as a prefix option
       #
@@ -29,6 +50,7 @@ module LiquidPlanner
           item.prefix_options[:workspace_id] = self.id
         end
       end
+
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: liquidplanner
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Brett Bender
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 -07:00
+date: 2012-03-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -137,7 +137,9 @@ files:
 - examples/README
 - examples/create_task.rb
 - examples/list_tasks.rb
+- examples/post-commit.rb
 - examples/support/helper.rb
+- examples/svn-post-commit.sh
 - examples/track_time.rb
 - lib/liquidplanner.rb
 - lib/liquidplanner/base.rb
@@ -155,20 +157,21 @@ files:
 - lib/liquidplanner/resources/estimate.rb
 - lib/liquidplanner/resources/event.rb
 - lib/liquidplanner/resources/folder.rb
-- lib/liquidplanner/resources/item.rb
 - lib/liquidplanner/resources/leaf.rb
 - lib/liquidplanner/resources/link.rb
 - lib/liquidplanner/resources/luggage.rb
 - lib/liquidplanner/resources/member.rb
 - lib/liquidplanner/resources/milestone.rb
+- lib/liquidplanner/resources/movable.rb
+- lib/liquidplanner/resources/move_or_package.rb
 - lib/liquidplanner/resources/note.rb
-- lib/liquidplanner/resources/order.rb
-- lib/liquidplanner/resources/priority.rb
+- lib/liquidplanner/resources/package.rb
+- lib/liquidplanner/resources/packageable.rb
 - lib/liquidplanner/resources/project.rb
-- lib/liquidplanner/resources/relative_resource.rb
+- lib/liquidplanner/resources/root.rb
 - lib/liquidplanner/resources/snapshot.rb
 - lib/liquidplanner/resources/task.rb
-- lib/liquidplanner/resources/tasklist.rb
+- lib/liquidplanner/resources/treeitem.rb
 - lib/liquidplanner/resources/workspace.rb
 - test/liquidplanner_resource_test.rb
 - test/workspace_test.rb
@@ -177,8 +180,8 @@ homepage: http://github.com/liquidplanner/liquidplanner
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/lib/liquidplanner/resources/order.rb

@@ -1,13 +0,0 @@
-module LiquidPlanner
-  # For resources that can be prioritized
-  module Order
-    include RelativeResource
-    def organize_before(item)
-      move_relative_to :organize, :before, item
-    end
-  
-    def organize_after(item)
-      move_relative_to :organize, :after, item
-    end
-  end
-end

data/lib/liquidplanner/resources/priority.rb

@@ -1,13 +0,0 @@
-module LiquidPlanner
-  # For resources that can be prioritized
-  module Priority
-    include RelativeResource
-    def prioritize_before(item)
-      move_relative_to :prioritize, :before, item
-    end
-  
-    def prioritize_after(item)
-      move_relative_to :prioritize, :after, item
-    end
-  end
-end

data/lib/liquidplanner/resources/relative_resource.rb

@@ -1,12 +0,0 @@
-module LiquidPlanner
-  module RelativeResource
-    def move_relative_to(tree, relative, other)
-      raise ArgumentError.new("tree must be prioritize or organize")  unless [:prioritize, :organize].include?(tree)
-      raise ArgumentError.new("relative must be before or after")     unless [:before, :after].include?(relative)
-      other_id = other.is_a?(LiquidPlanner::LiquidPlannerResource) ? other.id : other
-      
-      response = post("#{tree}_#{relative}", :other_id=>other_id)
-      load( self.class.format.decode( response.body ) )
-    end
-  end
-end