liquidplanner 0.0.3 → 0.0.4

data/Rakefile

@@ -14,7 +14,7 @@ begin
     gemspec.description = "LiquidPlanner API client, using ActiveResource"
     gemspec.email       = "api@liquidplanner.com"
     gemspec.homepage    = "http://github.com/liquidplanner/liquidplanner"
-    gemspec.authors     = ["Brett Bender", "Adam Sanderson"]
+    gemspec.authors     = ["Brett Bender", "Adam Sanderson", "Mark Holton"]
     
     gemspec.files       = FileList["[A-Z]*", "{examples,lib,test}/**/*"]
     

data/examples/README

@@ -1,7 +1,7 @@
 Command Line Examples:
 ======================
 
-Files: create_task.rb, list_tasks.rb, track_time.rb
+Files: create_task.rb, list_tasks.rb, track_time.rb, list_custom_fields.rb, update_custom_field_value.rb
 
 All of these examples expect you to pass in your account name and workspace id, 
 for instance:

data/examples/list_custom_fields.rb

@@ -0,0 +1,45 @@
+# Require the LiquidPlanner API.
+require File.dirname(__FILE__) + '/../lib/liquidplanner'
+
+# Require support libraries used by this example.
+require 'rubygems'                  
+require 'highline/import'           
+require 'active_support/all'        
+require File.dirname(__FILE__) + '/support/helper'
+
+# List a set of custom fields and custom field values in a workspace.
+#
+# You will:
+# * Access a workspace
+# * display the custom Project and custom Task fields in that workspace
+#
+# This example will use the highline library to handle input and output.
+# You can install it with:
+#     gem install highline
+
+email, password, space_id = get_credentials!
+
+# Create a new LiquidPlanner API object.  It requires the login credentials we gathered above.
+lp = LiquidPlanner::Base.new(:email=>email, :password=>password)
+
+# Fetch the user's workspace, and then print its name.
+workspace = lp.workspaces(space_id)
+say "#{workspace.name}: Custom Fields and Custom Field Values:" 
+say "-" * 40
+
+# Fetch custom fields for that workspace
+custom_fields = workspace.custom_fields(:all)
+
+# print the custom fields and custom field values
+custom_fields.each do |cf|
+  # LiquidPlanner::Resources::CustomField
+  # LiquidPlanner::Resources::CustomField::Value
+
+  # show the name, type, and value choices for the CustomField:
+  say "category: #{cf.category}"       if cf.category
+  say "name: #{cf.name} (id:#{cf.id})" if cf.name
+  cf.values.each do |cfv| # custom_field_values
+    say "label: #{cfv.label} (type: #{cfv.type} sort_order: #{cfv.sort_order} id: #{cfv.id})"
+  end
+  say "-" * 40
+end

data/examples/update_custom_field_value.rb

@@ -0,0 +1,63 @@
+# Require the LiquidPlanner API.
+require File.dirname(__FILE__) + '/../lib/liquidplanner'
+
+# Require support libraries used by this example.
+require 'rubygems'                  
+require 'highline/import'
+require File.dirname(__FILE__) + '/support/helper'
+
+require 'pp'
+# Get the user's credentials
+email, password, space_id = get_credentials!
+
+# Create a new LiquidPlanner API object with the login credentials
+lp = LiquidPlanner::Base.new(:email=>email, :password=>password)
+
+# Get the user's workspace and account, and then print its name.
+workspace   = lp.workspaces(space_id)
+account     = lp.account
+
+say "-" * 40
+# Get the user's first task
+tasks = workspace.tasks(:all, :filter=>'owner_id = me')
+projects = workspace.projects(:all, :filter=>'owner_id = me')
+
+custom_task_fields    = workspace.custom_fields(:all).select{|item| item.category == "task"}
+custom_project_fields = workspace.custom_fields(:all).select{|item| item.category == "project"}
+
+if tasks.empty? && projects.empty?
+  say "No tasks or projects are assigned to you."
+  exit
+else
+  task    = tasks.first
+  project = projects.first
+end
+
+say "Workspace: #{workspace.name} - Set a Custom Field Value on the first Task, Milestone, or Event in your space"
+say "#{task.type}: #{task.name}"
+say "* available Custom Task Fields:"
+
+# allows you to set all custom fields available on this task
+custom_task_fields.each do |cf|
+  say "#{cf.name}"
+  cf.values.each do |cfv| # options to choose from
+    say "#{cfv.label}"
+  end
+  cf_value = ask("Type in the Custom Field Value you wish to set on '#{task.name}'?", String)
+  puts "chose: #{cf_value}"
+  # HTTP PUT "'{'task':{'custom_field_values':{'your_task_field':'your_task_field_value'}}}'"
+  task.custom_field_values = {cf.name => cf_value}
+  task.save
+end
+
+# allows you to set all custom fields available on this task
+custom_project_fields.each do |cf|
+  say "#{cf.name}"
+  cf.values.each do |cfv| # options to choose from
+    say "#{cfv.label}"
+  end
+  cf_value = ask("Type in the Custom Field Value you wish to set on '#{task.name}'?", String)
+  puts "chose: #{cf_value}"
+  project.custom_field_values = {cf.name => cf_value}
+  project.save
+end

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.3"
+  VERSION      = "0.0.4"
   API_BASE_URL = "https://app.liquidplanner.com/api"
 end
 
@@ -16,6 +16,8 @@ require "net/http/post/multipart" # for uploading documents
 # could also glob these paths and require all matches...
 require "liquidplanner/base"
 require "liquidplanner/liquidplanner_resource"
+require "liquidplanner/resources/workspace_resource"
+
 require "liquidplanner/resources/account"
 require "liquidplanner/resources/member"
 require "liquidplanner/resources/workspace"
@@ -44,6 +46,7 @@ require "liquidplanner/resources/link"
 require "liquidplanner/resources/estimate"
 require "liquidplanner/resources/snapshot"
 require "liquidplanner/resources/activity"
+require "liquidplanner/resources/custom_field"
 
 require "liquidplanner/ext/hash"
 require "liquidplanner/ext/connection"

data/lib/liquidplanner/base.rb

@@ -31,6 +31,7 @@ module LiquidPlanner
       LiquidPlannerResource.site     = @api_base_url
       LiquidPlannerResource.user     = @email
       LiquidPlannerResource.password = @password
+      LiquidPlannerResource.connection.enable_gzip
     end
                 
   end

data/lib/liquidplanner/ext/connection.rb

@@ -7,5 +7,24 @@ module ActiveResource
       with_auth { request(:get, path, build_request_headers(headers, :get, self.site.merge(path))) }
     end
 
+    # force accept-encoding request header to "gzip"
+    # so that server compresses its response
+    #
+    def enable_gzip
+      default_header['accept-encoding'] = 'gzip'
+    end
+
+    # transparently decompress response body,
+    # if content-encoding indicates it is gzipped
+    #
+    alias_method :handle_response_without_gzip, :handle_response
+    def handle_response(response)
+      if 'gzip' == response['content-encoding']
+        response.body = Zlib::GzipReader.new(StringIO.new(response.body)).read
+        response.delete('content-encoding')
+      end
+      handle_response_without_gzip(response)
+    end
+
   end
 end

data/lib/liquidplanner/resources/custom_field.rb

@@ -0,0 +1,6 @@
+module LiquidPlanner
+  module Resources
+    class CustomField < WorkspaceResource
+    end
+  end
+end

data/lib/liquidplanner/resources/member.rb

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

data/lib/liquidplanner/resources/treeitem.rb

@@ -3,9 +3,7 @@
 #------------------------------------------------------------------------
 module LiquidPlanner
   module Resources
-    class Treeitem < LiquidPlanner::LiquidPlannerResource
-
-      self.prefix = "/api/workspaces/:workspace_id/"
+    class Treeitem < WorkspaceResource 
 
       def parent
         parent_id && Treeitem.find( :one, :from => "/api/workspaces/#{workspace_id}/treeitems/#{parent_id}" )

data/lib/liquidplanner/resources/workspace.rb

@@ -37,6 +37,10 @@ module LiquidPlanner
       def folders( scope=:all, options={} )
         Folder.find( scope, :params => { :workspace_id => self.id, :flat => true }.merge(options) )
       end
+      
+      def custom_fields( scope=:all, options={} )
+        CustomField.find( scope, :params => { :workspace_id => self.id }.merge(options) )
+      end
             
       protected
 

data/lib/liquidplanner/resources/workspace_resource.rb

@@ -0,0 +1,8 @@
+module LiquidPlanner
+  module Resources
+    class WorkspaceResource < LiquidPlanner::LiquidPlannerResource
+      self.prefix = "/api/workspaces/:workspace_id/"
+    end
+  end
+end
+

metadata

@@ -1,146 +1,102 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: liquidplanner
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Brett Bender
 - Adam Sanderson
+- Mark Holton
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-14 00:00:00 -07:00
+date: 2012-06-22 00:00:00.000000000 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activeresource
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2222498920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2222498920
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2222498160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: multipart-post
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2222498160
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: &2222497400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 0
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.1
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 0
-        - 1
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: highline
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2222497400
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &2222496660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 5
-        version: "1.5"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2222496660
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2222496180 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 9
-        - 8
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 0.9.8
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *2222496180
 description: LiquidPlanner API client, using ActiveResource
 email: api@liquidplanner.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - HISTORY
 - README.rdoc
 - Rakefile
 - examples/README
 - examples/create_task.rb
+- examples/list_custom_fields.rb
 - examples/list_tasks.rb
 - examples/post-commit.rb
 - examples/support/helper.rb
 - examples/svn-post-commit.sh
 - examples/track_time.rb
+- examples/update_custom_field_value.rb
 - lib/liquidplanner.rb
 - lib/liquidplanner/base.rb
 - lib/liquidplanner/debug.rb
@@ -153,6 +109,7 @@ files:
 - lib/liquidplanner/resources/client.rb
 - lib/liquidplanner/resources/comment.rb
 - lib/liquidplanner/resources/container.rb
+- lib/liquidplanner/resources/custom_field.rb
 - lib/liquidplanner/resources/document.rb
 - lib/liquidplanner/resources/estimate.rb
 - lib/liquidplanner/resources/event.rb
@@ -173,42 +130,34 @@ files:
 - lib/liquidplanner/resources/task.rb
 - lib/liquidplanner/resources/treeitem.rb
 - lib/liquidplanner/resources/workspace.rb
+- lib/liquidplanner/resources/workspace_resource.rb
 - test/liquidplanner_resource_test.rb
 - test/workspace_test.rb
 has_rdoc: true
 homepage: http://github.com/liquidplanner/liquidplanner
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: LiquidPlanner API client
-test_files: 
+test_files:
 - test/liquidplanner_resource_test.rb
 - test/workspace_test.rb