minmb-teambox-client 0.4.0

data/Gemfile

@@ -0,0 +1,11 @@
+# -*- mode: ruby; tab-width: 2; indent-tabs-mode: nil -*-
+
+source :rubygems
+
+group :development do
+  gem 'rake'
+  gem 'jeweler'
+  gem 'rspec'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    minmb-teambox-client (0.4.0)
+      httparty (~> 0.7.4)
+      json (~> 1.5.1)
+      minmb-teambox-client
+      oauth2 (~> 0.1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    crack (0.1.8)
+    diff-lcs (1.1.3)
+    faraday (0.5.7)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    git (1.2.5)
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.5.4)
+    multi_json (0.0.5)
+    multipart-post (1.1.5)
+    oauth2 (0.1.1)
+      faraday (~> 0.5.0)
+      multi_json (~> 0.0.4)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  minmb-teambox-client!
+  rake
+  rspec

data/History

@@ -0,0 +1,6 @@
+0.4.0 - May 25, 2011
+  * Updated for lasted API
+0.3.0 - March 19, 2011
+  * Complete revamp, update to latest Teambox API.
+0.0.1 - June 19, 2010
+  * Initial release, inspired by @jnunemaker's Twitter gem

data/License

@@ -0,0 +1,20 @@
+Copyright (c) 2009-2011 James Urquhart, Pablo Villalba
+
+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:
+
+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.rdoc

@@ -0,0 +1,30 @@
+
+minmb-teambox-client is a Ruby wrapper for Teambox ( http://www.teambox.com ) API.
+
+* Wraps the API in a client object with resources
+* Inspired by the philosophy of KISS, minimal spaghetti
+
+Check out the API docs at http://www.teambox.com/api for more details on the Teambox API.
+
+*Note:* this is a forked version pushed to RubyGems.org to fill in for the outdated version
+of the upstream gem.
+
+== Getting Started
+
+First, install the minmb-teambox-client gem:
+
+  gem install minmb-teambox-client
+
+Now, run "irb -rubygems" and this snippet to get the list of activities:
+
+  require 'teambox-client'
+  client = Teambox::Client.new(:auth => {:username => 'frank', :password => 'papapa'})
+  puts client.activities
+
+By default, teambox-client will connect to the hosted service at https://teambox.com/api/1; optionally you can:
+
+  client = Teambox::Client.new(:base_uri => 'http://teambox.mysite.com/api/1', :auth => {:username => 'frank', :password => 'papapa'})
+
+== Examples
+
+See the examples directory.

data/Rakefile

@@ -0,0 +1,44 @@
+# -*- mode: ruby; tab-width: nil; indent-tabs-mode: 2; encoding: utf-8 -*-
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "minmb-teambox-client"
+    gem.summary     = "A ruby gem wrapper for Teambox API"
+    gem.description = "Provides methods to read and write to Teambox for ruby apps"
+    gem.email       = "martin.hager@minmb.se"
+    gem.homepage    = "http://github.com/minmb/teambox-ruby-client"
+    gem.authors     = ["Pablo Villalba", "James Urquhart", "Martin Häger"]
+
+    gem.add_dependency("httparty", "~> 0.7.4")
+    gem.add_dependency("oauth2", "~> 0.1.1")
+    gem.add_dependency("json", "~> 1.5.1")
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/*spec.rb"
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "minmb-teambox-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/examples/conversation.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'teambox-client')
+require 'pp'
+
+TEAMBOX_SERVER = ENV["TEAMBOX_SERVER"] || "http://localhost:3000"
+
+client = Teambox::Client.new({:base_uri => "#{TEAMBOX_SERVER}/api/1", :auth => {:user => 'frank', :password => 'papapa'}})
+project = client.project('earthworks')
+
+# Make a conversation
+project.create_conversation({:body => 'Test conversation', :simple => true}) # return conversation resource
+pp project.conversations[0].data

data/examples/task.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'teambox-client')
+require 'pp'
+
+TEAMBOX_SERVER = ENV["TEAMBOX_SERVER"] || "http://localhost:3000"
+
+client = Teambox::Client.new({:base_uri => "#{TEAMBOX_SERVER}/api/1", :auth => {:user => 'frank', :password => 'papapa'}})
+project = client.project('earthworks')
+
+# Make a task list with a task, update task to hold
+task_list = project.create_task_list(:name => 'Teambox App')
+task = project.create_task(task_list, {:name => 'Decide what we are going to make'})
+task.status_name = :hold
+task.comment = "We have no idea what we are making!"
+task.save
+pp task.data
+pp task.comments[0].data

data/examples/users.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'teambox-client')
+require 'pp'
+
+TEAMBOX_SERVER = ENV["TEAMBOX_SERVER"] || "http://localhost:3000"
+
+client = Teambox::Client.new({:base_uri => "#{TEAMBOX_SERVER}/api/1", :auth => {:user => 'frank', :password => 'papapa'}})
+puts "Logged in as #{client.current_user.name} (#{client.current_user.username})"
+
+# Get info on single project
+project = client.project('earthworks')
+puts "Earthworks owner: #{client.project('earthworks').owner_user.reload.name}"
+
+# Get info on all projects (subject to limits)
+client.projects.each do |project|
+  puts "Project: #{project.name} (#{project.permalink})"
+  puts "  Owned by: #{project.owner_user.name}"
+end
+

data/lib/teambox-client/models/activity.rb

@@ -0,0 +1,27 @@
+module Teambox
+  class Activity < Teambox::Resource
+    # Teambox::User who generated this activity
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    # The Teambox::Resource which generated this activity
+    def target
+      get_or_make_reference(@data['target_type'], @data, 'target_id')
+    end
+    
+    # The Teambox::Project this activity belongs to
+    def project
+      get_or_make_reference('Project', @data, 'project_id')
+    end
+    
+    # The target of the comment if this is a Teambox::Comment
+    def comment_target
+      get_or_make_reference(@data['comment_target_type'], @data, 'comment_target_id')
+    end
+    
+    def url #:nodoc:
+      "/activities/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/comment.rb

@@ -0,0 +1,55 @@
+module Teambox
+  class Comment < Teambox::Resource
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    def project
+      get_or_make_reference('Project', @data, 'project_id')
+    end
+    
+    # The Teambox::Resource which this comment belongs to
+    def target
+      get_or_make_reference(@data['target_type'], @data, 'target_id')
+    end
+    
+    # The Teambox::Person assigned to the task at time of posting, if the comment belongs to a Teambox::Task
+    def assigned
+      get_or_make_reference('Person', @data, 'assigned_id')
+    end
+    
+    # The Teambox::Person previously assigned to the task at time of posting, if the comment belongs to a Teambox::Task
+    def previous_assigned
+      get_or_make_reference('Person', @data, 'previous_assigned_id')
+    end
+    
+    # The name of the status assigned to the Teambox::Task at time of posting
+    def status_name
+      @data['status'].nil? ? nil : Teambox::Task::STATUS_NAMES[@data['status']]
+    end
+    
+    # The name of the previous status assigned to the Teambox::Task at time of posting
+    def previous_status_name
+      @data['previous_status'].nil? ? nil : Teambox::Task::STATUS_NAMES[@data['previous_status']]
+    end
+    
+    # The due date of the Teambox::Task at time of posting
+    def due_on
+      @data['due_on'] ? Time.parse(data['due_on']) : nil
+    end
+    
+    # The previous due date of the Teambox::Task at time of posting
+    def previous_due_on
+      @data['previous_due_on'] ? Time.parse(data['previous_due_on']) : nil
+    end
+    
+    # A list of Teambox::Upload attached to this comment
+    def uploads
+      get_or_make_references('Upload', @data, 'upload_ids', 'uploads')
+    end
+    
+    def url #:nodoc:
+      "/comments/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/conversation.rb

@@ -0,0 +1,26 @@
+module Teambox
+  class Conversation < Teambox::Resource
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    # Last two Teambox::Comment of the conversation (may include first_comment)
+    def recent_comments
+      get_or_make_references('Comment', @data, 'recent_comment_ids')
+    end
+    
+    # First Teambox::Comment of the conversation
+    def first_comment
+      get_or_make_reference('Comment', @data, 'first_comment_id')
+    end
+    
+    # Gets a Teambox::ResultSet of all Teambox::Comment objects belonging to the conversation
+    def comments
+      @list.client.get("#{url}/comments")
+    end
+    
+    def url #:nodoc:
+      "/conversations/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/divider.rb

@@ -0,0 +1,15 @@
+module Teambox
+  class Divider < Teambox::Resource
+    def page
+      get_or_make_reference('Page', @data, 'page_id')
+    end
+    
+    def project
+      get_or_make_reference('Project', @data, 'project_id')
+    end
+    
+    def url #:nodoc:
+      "/pages/#{@data['page_id']}/dividers/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/invitation.rb

@@ -0,0 +1,21 @@
+module Teambox
+  class Invitation < Teambox::Resource
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    # Teambox::User who is the subject of this invite
+    def invited_user
+      get_or_make_reference('User', @data, 'invited_user_id')
+    end
+    
+    # Teambox::Project the subject is being invited to
+    def project
+      get_or_make_reference('Project', @data, 'project_id')
+    end
+    
+    def url #:nodoc:
+      "/invitations/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/membership.rb

@@ -0,0 +1,15 @@
+module Teambox
+  class Membership < Teambox::Resource
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    def organization
+      get_or_make_reference('Organization', @data, 'organization_id')
+    end
+    
+    def url #:nodoc:
+      "/organizations/#{@data['organization_id']}/memberships/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/note.rb

@@ -0,0 +1,15 @@
+module Teambox
+  class Note < Teambox::Resource
+    def page
+      get_or_make_reference('Page', @data, 'page_id')
+    end
+    
+    def project
+      get_or_make_reference('Project', @data, 'project_id')
+    end
+    
+    def url #:nodoc:
+      "/pages/#{@data['page_id']}/notes/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/organization.rb

@@ -0,0 +1,18 @@
+module Teambox
+  class Organization < Teambox::Resource
+    
+    # Gets a Teambox::ResultSet of all Teambox::Project objects belonging to the organization
+    def projects
+      @list.client.get("#{url}/projects")
+    end
+    
+    # Gets a Teambox::ResultSet of all Teambox::Membership objects belonging to the organization
+    def memberships
+      @list.client.get("#{url}/memberships")
+    end
+    
+    def url #:nodoc:
+      "/organizations/#{@data['permalink']||@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/page.rb

@@ -0,0 +1,20 @@
+module Teambox
+  class Page < Teambox::Resource
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    def project
+      get_or_make_reference('Project', @data, 'project_id')
+    end
+    
+    # Returns an Array of Teambox::PageSlot
+    def slots
+      get_or_make_references('PageSlot', @data, 'slot_ids', 'slots')
+    end
+    
+    def url #:nodoc:
+      "/projects/#{@data['project_id']}/pages/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/page_slot.rb

@@ -0,0 +1,16 @@
+module Teambox
+  class PageSlot < Teambox::Resource
+    def page
+      get_or_make_reference('Page', @data, 'page_id')
+    end
+    
+    # The Teambox::Note, Teambox::Divider, or Teambox::Upload attached to this slot
+    def rel_object
+      get_or_make_reference(@data['rel_object_type'], @data, 'rel_object_id')
+    end
+    
+    def url #:nodoc:
+      nil
+    end
+  end
+end

data/lib/teambox-client/models/person.rb

@@ -0,0 +1,19 @@
+module Teambox
+  class Person < Teambox::Resource
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    def source_user
+      get_or_make_reference('User', @data, 'source_user_id')
+    end
+    
+    def project
+      get_or_make_reference('Project', @data, 'project_id')
+    end
+    
+    def url #:nodoc:
+      "/projects/#{@data['project_id']}/people/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/project.rb

@@ -0,0 +1,52 @@
+module Teambox
+  class Project < Teambox::Resource
+    # Teambox::User who created this project
+    def owner_user
+      get_or_make_reference('User', @data, 'owner_user_id')
+    end
+    
+    def url #:nodoc:
+      "/projects/#{@data['permalink']||@data['id']}"
+    end
+    
+    # Returns a Teambox::ResultSet of conversations in this project
+    def conversations(query=nil)
+      @list.client.get("#{url}/conversations", query)
+    end
+    
+    # Returns a Teambox::ResultSet of task lists in this project
+    def task_lists(query=nil)
+      @list.client.get("#{url}/task_lists", query)
+    end
+    
+    # Returns a Teambox::ResultSet of tasks in this project
+    def tasks(query=nil)
+      @list.client.get("#{url}/tasks", query)
+    end
+    
+    # Returns a Teambox::ResultSet of comments in this project
+    def comments(query=nil)
+      @list.client.get("#{url}/comments", query)
+    end
+    
+    # Creates a new Teambox::Conversation in this project
+    def create_conversation(opts={})
+      @list.client.post("#{url}/conversations", opts)
+    end
+    
+    # Creates a new Teambox::TaskList in this project
+    def create_task_list(opts={})
+      @list.client.post("#{url}/task_lists", opts)
+    end
+    
+    # Creates a new Teambox::Task in this project
+    def create_task(task_list, opts={})
+      @list.client.post("#{url}/task_lists/#{task_list.id}/tasks", opts)
+    end
+    
+    # Creates a new Teambox::Comment in target belonging to this project
+    def create_comment(target, opts={})
+      @list.client.post("#{url}/comments", opts.merge({'target_type' => target.class.to_s, 'target_id' => target.id}))
+    end
+  end
+end

data/lib/teambox-client/models/task.rb

@@ -0,0 +1,66 @@
+module Teambox
+  class Task < Teambox::Resource
+    STATUS_NAMES = [:new, :open, :hold, :resolved, :rejected]
+    STATUSES = [0,1,2,3,4]
+    
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    # Teambox::TaskList this task belongs to
+    def task_list
+      get_or_make_reference('TaskList', @data, 'task_list_id')
+    end
+    
+    # First Teambox::Comment of the task
+    def first_comment
+      get_or_make_reference('Comment', @data, 'first_comment_id')
+    end
+    
+    # Last two Teambox::Comment of the task (may include first_comment)
+    def recent_comments
+      get_or_make_references('Comment', @data, 'recent_comment_ids')
+    end
+    
+    # Gets a Teambox::ResultSet of all Teambox::Comment objects belonging to the conversation
+    def comments
+      @list.client.get("#{url}/comments")
+    end
+    
+    # The Teambox::Person assigned this task
+    def assigned
+      get_or_make_reference('Person', @data, 'assigned_id')
+    end
+    
+    # Sets the Teambox::Person assigned this task
+    def assigned=(value)
+      @data['assigned_id'] = set_reference('Person', value).id
+    end
+    
+    # Current due date
+    def due_on
+      @data['due_on'] ? Date.parse(@data['due_on']) : nil
+    end
+    
+    def due_on=(value)
+      @data['due_on'] = value.strftime('%Y-%m-%d %H:%M:%S %z')
+    end
+    
+    def comment=(value)
+      @data['comments_attributes'] = {'0' => {'body' => value}}
+    end
+    
+    # Current status
+    def status_name
+      STATUS_NAMES[@data['status']]
+    end
+    
+    def status_name=(value)
+      @data['status'] = STATUS_NAMES.index(value.to_sym)
+    end
+    
+    def url #:nodoc:
+      "/tasks/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/task_list.rb

@@ -0,0 +1,26 @@
+module Teambox
+  class TaskList < Teambox::Resource
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    # Time this task list commences
+    def start_on
+      @data.has_key?('start_on') ? Time.parse(data['start_on']) : nil
+    end
+    
+    # Time this task list finished
+    def finish_on
+      @data.has_key?('finish_on') ? Time.parse(data['finish_on']) : nil
+    end
+    
+    # Time this task list was completed
+    def completed_at
+      @data.has_key?('completed_at') ? Time.parse(data['completed_at']) : nil
+    end
+    
+    def url #:nodoc:
+      "/task_lists/#{@data['id']}"
+    end
+  end
+end

data/lib/teambox-client/models/teambox_data.rb

@@ -0,0 +1,16 @@
+module Teambox
+  class TeamboxData < Teambox::Resource
+    def user
+      get_or_make_reference('User', @data, 'user_id')
+    end
+    
+    # Time this data was processed
+    def processed_at
+      @data.has_key?('processed_at') ? Time.parse(data['processed_at']) : nil
+    end
+    
+    def url #:nodoc:
+      nil
+    end
+  end
+end