playnicely 0.1.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.textile

@@ -0,0 +1,119 @@
+h1. Ruby PlayNice.ly API Client
+
+This is the official PlayNice.ly API Ruby client library.
+
+For full details of the API see the "documentation":http://docs.playnice.ly/api/.
+
+h2. Installation
+
+Details of how to install the client
+
+(Once I get around to publishing the gem!)
+
+@sudo gem install playnicely@
+
+h2. Getting started
+
+Here is a short example script to walk you through the basics of using the client library:
+
+<pre>
+require 'playnicely'
+
+client = PlayNicely::Client.new('username', 'password')
+
+# Get some information about the current user
+me = client.current_user
+my_projects = client.user_projects(me.user_id)
+
+puts "Logged in as #{me.username}"
+puts "Your projects are:"
+my_projects.each do |project|
+    puts "#{project.name} (ID: #{project.project_id})"
+end
+
+# Get the first of your projects so that we can show some items for it
+project = my_projects[0]
+
+puts "Items in project #{project.name}"
+
+# list all items
+client.project_items(project.project_id).each do |item|
+    puts item.subject
+end
+
+puts "\nAll done! Now you try"
+</pre>
+
+h2. Reference
+
+You can instantiate the client as follows:
+
+<pre>
+client = PlayNicely::Client.new('username', 'password')
+</pre>
+
+Further "authentication information":http://docs.playnice.ly/api/authentication/ can be found in the main "API Documentation":http://docs.playnice.ly/api/.
+
+A quick overview of the available commands:
+
+h3. Projects
+
+*To retrieve a single project ("API Reference":http://docs.playnice.ly/api/reference/project/#show):*
+
+@client.project(project_id)@
+
+This will return the compact version of a project.
+
+@client.project(project_id, "full")@
+
+Will return the full version of a project.
+
+h3. Milestones
+
+*To retrieve a single milestone ("API Reference":http://docs.playnice.ly/api/reference/milestone/#show):*
+
+@client.milestone(project_id, milestone_id)@
+
+h3. Items
+
+*To retrieve a single item ("API Reference":http://docs.playnice.ly/api/reference/item/#show):*
+
+@client.item(project_id,item_id)@
+
+
+h3. Users
+
+*To retrieve a single user ("API Reference":http://docs.playnice.ly/api/reference/user/#show):*
+
+@client.user(user_id)@
+
+_Examples:_
+
+<pre>
+user_compact = client.user(999) # the detail parameter defaults to '"compact"'
+user_full = client.user(999, detail="full")
+user_id = client.user(999, detail="id") # returns an integer
+</pre>
+
+*To retrieve a list of a user's projects ("API Reference":http://docs.playnice.ly/api/reference/user/#list-projects):*
+
+@client.user_projects(user_id)@
+
+_Examples:_
+
+<pre>
+# How to retrieve a list of projects in each of the available detail levels
+projects_compact = client.user_projects(999) # the detail parameter defaults to '"compact"'
+projects_full = client.user_projects(999, "full")
+projects_id = client.user_projects(999, "id") # returns an integer
+</pre>
+
+*Important note:* Only projects to which the authenticated user is also a member will be returned. If you require a complete list of all projects for a user, then you must authenticate as that user.
+
+h2. Contributing
+
+Please feel free to fork this repository and make any changes you feel are necessary. We will be happy to accept pull requests that we feel will benefit other users of the client.
+
+h2. Help
+
+If you run into problems then you can get in touch with the author ("Rob":http://twitter.com/robbiehudson/) at "support@playnice.ly":mailto:support@playnice.ly.

data/Rakefile

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'shoulda/tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.ruby_opts = ["-rubygems"] if defined? Gem
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/lib/playnicely/client.rb

@@ -0,0 +1,113 @@
+module PlayNicely
+  class Client
+    include HTTParty
+    format :json
+    base_uri "https://api.playnice.ly/v1/"
+    
+    def initialize(username, password)
+      @username = username
+      @password = password
+      
+      # call HTTParty
+      self.class.basic_auth(@username, @password)
+    end
+    
+    def project(project_id, detail='compact')
+      auth_get("/project/#{project_id}/show/", {:query => {:detail => detail}})
+    end
+    
+    def user(user_id, detail='compact')
+      auth_get("/user/#{user_id}/show/", {:query => {:detail => detail}})
+    end
+    
+    def current_user(detail='compact')
+      auth_get('/user/current/show/', {:query => {:detail => detail}})
+    end
+    
+    def user_projects(user_id, detail='compact')
+      auth_get("/user/#{user_id}/project/list/", {:query => {:detail => detail}})
+    end
+    
+    def current_user_projects(detail='compact')
+      auth_get("/user/current/project/list/",  {:query => {:detail => detail}})
+    end
+    
+    def milestone(project_id, milestone_id, detail='compact')
+      auth_get("/project/#{project_id}/milestone/#{milestone_id}/show/",  {:query => {:detail => detail}})
+    end
+    
+    def project_milestones(project_id, detail='compact')
+      auth_get("/project/#{project_id}/milestone/list/", {:query => {:detail => detail}})
+    end
+    
+    def item(project_id, item_id, detail='compact')
+      auth_get("/project/#{project_id}/item/#{item_id}/show/",  {:query => {:detail => detail}})
+    end
+    
+    def project_items(project_id, detail='compact')
+      auth_get("/project/#{project_id}/item/list/",  {:query => {:detail => detail}})
+    end
+    
+    def create_item(project_id, data)
+      auth_post("/project/#{project_id}/item/create/", :body => data.to_json)
+    end
+    
+    def update_item(project_id, item_id, data)
+      auth_post("/project/#{project_id}/item/#{item_id}/update/", :body => data.to_json)
+    end
+    
+    private
+    def auth_get path, options = {}
+      get(path, options)
+    end
+    
+    def auth_post path, options = {}
+      post(path, options)
+    end
+    
+    def post path, options = {}
+      response = self.class.post(path, options)
+      
+      if response.nil?
+        return
+      end
+      
+      Hashie::Mash.new(response)
+    end
+    
+    def get path, options = {}
+      response = self.class.get(path, options)
+      
+      if response.nil?
+        return
+      end
+      
+      # do some foo to check if we have an array of hashes or just a hash
+      
+      if response.is_a? Array
+        response.collect! { |x| x.is_a?(Hash) ? Hashie::Mash.new(x) : x }
+      elsif response.is_a? Integer
+        Integer(response)
+      else
+        Hashie::Mash.new(response)
+      end
+    end
+    
+    def self.get(*args); handle_response super end
+    def self.post(*args); handle_response super end
+
+    def self.handle_response(response)
+      case response.code
+      when 401; raise Unauthorized.new Hashie::Mash.new(response).error_message
+      when 403; raise RateLimitExceeded.new Hashie::Mash.new(response).error_message
+      when 404; raise NotFound.new Hashie::Mash.new(response).error_message
+      when 400...500; raise ClientError.new Hashie::Mash.new(response).error_message
+      when 500...600; raise ServerError.new(Hashie::Mash.new(response).error_message)
+      else; response
+      end
+    end
+  end
+end
+    
+    
+    

data/lib/playnicely/version.rb

@@ -0,0 +1,3 @@
+module PlayNicely
+  VERSION = "0.1.1".freeze unless defined?(PlayNicely::VERSION)
+end

data/lib/playnicely.rb

@@ -0,0 +1,23 @@
+require 'forwardable'
+
+require 'httparty'
+require 'hashie'
+require 'json'
+
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'playnicely/client'
+
+module PlayNicely
+  extend SingleForwardable
+  
+  def self.client; Client.new end
+  
+  def_delegators :client, :project
+  class Error < StandardError; end
+  class Unauthorized < Error; end
+  class NotFound < Error; end
+  class ClientError < Error; end
+  class ServerError < Error; end
+end

data/playnicely.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/playnicely/version', __FILE__)
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Gem::Specification.new do |s|
+  s.add_runtime_dependency('hashie', '~> 0.4.0')
+  s.add_runtime_dependency('httparty', '~> 0.6.1')
+  s.add_runtime_dependency('json')
+  s.add_development_dependency('fakeweb', '~> 1.3')
+  s.add_development_dependency('jnunemaker-matchy', '~> 0.4')
+  s.add_development_dependency('mocha', '~> 0.9')
+  s.add_development_dependency('shoulda', '~> 2.11')
+  s.name = 'playnicely'
+  s.authors = ["Rob Hudson"]
+  s.description = %q{Simple wrapper for the PlayNicely API v1}
+  s.email = ['rob@playnice.ly']
+  s.homepage = 'http://github.com/playnicelyapp/playnicely-rb'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+  s.summary = %q{Wrapper for the PlayNicely API}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.platform = Gem::Platform::RUBY
+  s.version = PlayNicely::VERSION.dup
+  s.has_rdoc = false
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+end
+

data/test/client_test.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class ClientTest < Test::Unit::TestCase
+  context "playnicely responds with an error" do
+    should "raise unauthorized exception" do
+      stub_get("https://robbiehudson:wrong-password@api.playnice.ly/v1/project/1/show/?detail=compact", "project-compact.json", ["401", "Unauthorized"])
+      lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::Unauthorized)
+    end
+    
+    should "raise server error" do
+      stub_get("https://robbiehudson:wrong-password@api.playnice.ly/v1/project/1/show/?detail=compact", "server-error.json", ["500", "Unauthorized"])
+      lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::ServerError)
+      
+      # now try again but wrap call and check exception content -- stupid shoulda!
+      begin
+        PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)
+      rescue PlayNicely::ServerError => e
+        e.message.should == "A description of the problem"
+      else
+        assert_true false
+      end
+    end
+    
+    should "raise client error" do
+      stub_get("https://robbiehudson:wrong-password@api.playnice.ly/v1/project/1/show/?detail=compact", "server-error.json", ["405", "Unauthorized"])
+      lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::ClientError)
+    end
+    
+    should "raise not found error" do
+      stub_get("https://robbiehudson:wrong-password@api.playnice.ly/v1/project/1/show/?detail=compact", "server-error.json", ["404", "Unauthorized"])
+      lambda {PlayNicely::Client.new('robbiehudson', 'wrong-password').project(1)}.should raise_error(PlayNicely::NotFound)
+    end    
+  end
+end

data/test/fixtures/item-compact.json

@@ -0,0 +1,9 @@
+{ 
+  "body" : "We really need synchronous replication so that the widget can more effectively talk to the gizmo",
+  "item_id" : 2,
+  "milestone_id" : 1,
+  "project_id" : 1,
+  "status" : "closed",
+  "subject" : "Slave disconnects from proxied Master / keepalive",
+  "type_name" : "bug"
+}

data/test/fixtures/milestone-compact.json

@@ -0,0 +1,6 @@
+{
+   "milestone_id":2,
+   "project_id":1,
+   "name":"Second milestone",
+   "item_ids":[ 6, 7, 8, 9, 10 ]
+}

data/test/fixtures/milestone-full.json

@@ -0,0 +1,10 @@
+{
+   "name":"Second milestone",
+   "item_ids":[ 6, 7, 8, 9, 10 ],
+   "created_at":"2010-12-14T16:36:27+00:00",
+   "updated_at":"2010-12-14T16:36:28+00:00",
+   "created_by":null,
+   "milestone_id":2,
+   "project_id":1,
+   "updated_by":null
+}

data/test/fixtures/project-compact.json

@@ -0,0 +1,7 @@
+{
+   "project_id":1,
+   "name":"Alan Parsons Project",
+   "item_ids":[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ],
+   "user_ids":[ 1, 3 ],
+   "milestone_ids":[ 1, 2 ]
+}

data/test/fixtures/project-full.json

@@ -0,0 +1,11 @@
+{
+   "project_id":1,
+   "name":"Alan Parsons Project",
+   "item_ids":[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ],
+   "user_ids":[ 1, 3 ],
+   "milestone_ids":[ 1, 2 ],
+   "created_at":"2010-12-14T16:03:34+00:00",
+   "created_by":2,
+   "updated_at":"2010-12-14T16:03:35+00:00",
+   "updated_by":2
+}

data/test/fixtures/project-id.json

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

data/test/fixtures/project-items-compact.json

@@ -0,0 +1,20 @@
+[
+   {
+      "body":"Example item body",
+      "status":"closed",
+      "project_id":1,
+      "item_id":1,
+      "milestone_id":1,
+      "type_name":"bug",
+      "subject":"Request: synchronous replication"
+   },
+   {
+      "body":"Example item body",
+      "status":"closed",
+      "project_id":1,
+      "item_id":2,
+      "milestone_id":1,
+      "type_name":"bug",
+      "subject":"Slave disconnects from proxied Master / keepalive"
+   }
+]

data/test/fixtures/project-items-id.json

@@ -0,0 +1 @@
+[1,2]

data/test/fixtures/project-milestones-compact.json

@@ -0,0 +1,14 @@
+[
+   {
+      "milestone_id":1,
+      "project_id":1,
+      "name":"First milestone",
+      "item_ids":[ 1, 2, 3, 4, 5 ]
+   },
+   {
+      "milestone_id":2,
+      "project_id":1,
+      "name":"Second milestone",
+      "item_ids":[ 6, 7, 8, 9, 10 ]
+   }
+]

data/test/fixtures/project-milestones-full.json

@@ -0,0 +1,22 @@
+[
+   {
+      "name":"First milestone",
+      "item_ids":[ 1, 2, 3, 4, 5 ],
+      "created_at":"2010-12-18T14:19:08+00:00",
+      "updated_at":"2010-12-18T14:19:10+00:00",
+      "created_by":2,
+      "milestone_id":1,
+      "project_id":1,
+      "updated_by":null
+   },
+   {
+      "name":"Second milestone",
+      "item_ids":[ 6, 7, 8, 9, 10 ],
+      "created_at":"2010-12-18T14:19:08+00:00",
+      "updated_at":"2010-12-18T14:19:10+00:00",
+      "created_by":null,
+      "milestone_id":2,
+      "project_id":1,
+      "updated_by":null
+   }
+]

data/test/fixtures/project-milestones-id.json

@@ -0,0 +1 @@
+[1, 2]

data/test/fixtures/server-error.json

@@ -0,0 +1,4 @@
+{
+	"error_message": "A description of the problem",
+	"type": "MessageTypeError"
+}

data/test/fixtures/user-compact.json

@@ -0,0 +1,7 @@
+{
+   "user_id":1,
+   "username":"adamcharnock",
+   "first_name":"Adam",
+   "surname":"Charnock",
+   "image":"http://app.playnice.ly/user/1/image/"
+}

data/test/fixtures/user-full.json

@@ -0,0 +1,10 @@
+{
+   "user_id":1,
+   "username":"adamcharnock",
+   "first_name":"Adam",
+   "surname":"Charnock",
+   "image":"http://playnicely.owdev.co.uk:8000/user/1/image/",
+   "project_ids":[1, 2, 3, 4],
+   "updated_at":"2010-12-16T14:44:28+00:00",
+   "created_at":"2010-12-16T14:44:28+00:00"
+}

data/test/fixtures/user-projects-compact.json

@@ -0,0 +1,16 @@
+[
+   {
+      "project_id":1,
+      "name":"Alan Parsons Project",
+      "item_ids":[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ],
+      "user_ids":[ 1, 3 ],
+      "milestone_ids":[ 1, 2 ]
+   },
+   {
+      "project_id":2,
+      "name":"The Bacon Street Project",
+      "item_ids":[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ],
+      "user_ids":[ 1, 4 ],
+      "milestone_ids":[ 1, 2 ]
+   }
+]

data/test/fixtures/user-projects-full.json

@@ -0,0 +1,24 @@
+[
+   {
+      "name":"Alan Parsons Project",
+      "item_ids":[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ],
+      "created_at":"2010-12-18T15:45:55+00:00",
+      "updated_at":"2010-12-18T15:45:55+00:00",
+      "created_by":2,
+      "user_ids":[ 1, 3 ],
+      "project_id":1,
+      "milestone_ids":[ 1, 2 ],
+      "updated_by":null
+   },
+   {
+      "name":"The Bacon Street Project",
+      "item_ids":[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ],
+      "created_at":"2010-12-18T15:45:55+00:00",
+      "updated_at":"2010-12-18T15:45:55+00:00",
+      "created_by":2,
+      "user_ids":[ 1, 4 ],
+      "project_id":2,
+      "milestone_ids":[ 1, 2 ],
+      "updated_by":null
+   }
+]

data/test/fixtures/user-projects-id.json

@@ -0,0 +1 @@
+[1, 2, 3, 4]

data/test/helper.rb

@@ -0,0 +1,38 @@
+require 'test/unit'
+require 'pathname'
+
+require 'shoulda'
+require 'matchy'
+# require 'mocha'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'playnicely'
+
+FakeWeb.allow_net_connect = false
+
+class Test::Unit::TestCase
+end
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+def playnicely_url(url)
+  url =~ /^https/ ? url : "https://api.playnice.ly/v1/#{url}"
+end
+
+def stub_request(method, url, filename, status=nil)
+  options = {:body => ""}
+  options.merge!({:body => status.last}) if status
+  options.merge!({:body => fixture_file(filename)}) if filename
+  options.merge!({:status => status}) if status
+
+  FakeWeb.register_uri(method, playnicely_url(url), options)
+end
+
+def stub_get(*args); stub_request(:get, *args) end
+def stub_post(*args); stub_request(:post, *args) end

data/test/item_test.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class ItemTest < Test::Unit::TestCase
+  
+  context "when authenticated" do
+    setup do
+      @client = PlayNicely::Client.new('robbiehudson', 'number42')
+    end
+    
+    should "show compact item information" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/item/2/show/?detail=compact", "item-compact.json")
+      item = @client.item(1,2)
+      item.body.should == "We really need synchronous replication so that the widget can more effectively talk to the gizmo"
+      item.item_id.should == 2
+      item.milestone_id.should == 1
+      item.project_id.should == 1
+      item.status.should == "closed"
+      item.subject.should == "Slave disconnects from proxied Master / keepalive"
+      item.type_name.should == "bug"
+    end
+    
+    should "list compact item information for project" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/item/list/?detail=compact", "project-items-compact.json")
+      items = @client.project_items(1)
+      items.length.should == 2
+      
+      item1 = items[0]
+      item1.body.should == "Example item body"
+      item1.status.should == "closed"
+      item1.project_id.should == 1
+      item1.item_id.should == 1
+      item1.milestone_id.should == 1
+      item1.type_name.should == "bug"
+      item1.subject.should == "Request: synchronous replication"
+      
+      item2 = items[1]
+      item2.body.should == "Example item body"
+      item2.status.should == "closed"
+      item2.project_id.should == 1
+      item2.item_id.should == 2
+      item2.milestone_id.should == 1
+      item2.type_name.should == "bug"
+      item2.subject.should == "Slave disconnects from proxied Master / keepalive"
+    end
+    
+    should "list item ids for project" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/item/list/?detail=id", "project-items-id.json")
+      items = @client.project_items(1, "id")
+      items.length.should == 2
+      items[0].should == 1
+      items[1].should == 2
+    end
+    
+    should "create item in project" do
+      stub_post("https://robbiehudson:number42@api.playnice.ly/v1/project/1/item/create/", "item-compact.json")
+      item = @client.create_item(1, {:body => "We really need synchronous replication so that the widget can more effectively talk to the gizmo",
+        :item_id  => 2,
+        :milestone_id => 1,
+        :project_id => 1,
+        :involved => [2],
+        :responsible => 2,
+        :status => "closed",
+        :subject => "Slave disconnects from proxied Master / keepalive",
+        :type_name => "bug"})
+      
+      item.body.should == "We really need synchronous replication so that the widget can more effectively talk to the gizmo"
+      item.item_id.should == 2
+      item.milestone_id.should == 1
+      item.project_id.should == 1
+      item.status.should == "closed"
+      item.subject.should == "Slave disconnects from proxied Master / keepalive"
+      item.type_name.should == "bug"
+    end
+    
+    should "update item in project" do
+      stub_post("https://robbiehudson:number42@api.playnice.ly/v1/project/1/item/2/update/", nil)
+      @client.update_item(1, 2, {:body => "We really need synchronous replication so that the widget can more effectively talk to the gizmo",
+        :status => "closed",
+        :subject => "Slave disconnects from proxied Master / keepalive",
+        :type_name => "bug"})
+    end
+  end
+end

data/test/milestone_test.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class MilestoneTest < Test::Unit::TestCase
+  
+  context "when authenticated" do
+    setup do
+      @client = PlayNicely::Client.new('robbiehudson', 'number42')
+    end
+    
+    should "show compact milestone information" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/milestone/2/show/?detail=compact", "milestone-compact.json")
+      milestone = @client.milestone(1, 2)
+      milestone.milestone_id.should == 2
+      milestone.project_id.should == 1
+      milestone.name.should == "Second milestone"
+      milestone.item_ids.should == [ 6, 7, 8, 9, 10 ]
+    end
+    
+    should "show full milestone information" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/milestone/2/show/?detail=full", "milestone-full.json")
+      milestone = @client.milestone(1, 2, 'full')
+      milestone.milestone_id.should == 2
+      milestone.project_id.should == 1
+      milestone.name.should == "Second milestone"
+      milestone.item_ids.should == [ 6, 7, 8, 9, 10 ]
+      
+      milestone.created_at.should == Time.utc(2010,12,14,16,36,27)
+      milestone.updated_at.should == Time.utc(2010,12,14,16,36,28)
+      milestone.created_by.should == nil
+      milestone.updated_by.should == nil
+    end
+    
+    should "show milestone ids for project" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/milestone/list/?detail=id", "project-milestones-id.json")
+      milestones = @client.project_milestones(1, 'id')
+      milestones.should == [1, 2]
+    end
+    
+    should "show compact milestones for project" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/milestone/list/?detail=compact", "project-milestones-compact.json")
+      milestones = @client.project_milestones(1)
+      milestones.length.should == 2
+      
+      milestone1 = milestones[0]
+      milestone1.milestone_id.should == 1
+      milestone1.project_id.should == 1
+      milestone1.name.should == "First milestone"
+      milestone1.item_ids.should == [ 1, 2, 3, 4, 5 ]
+      
+      milestone2 = milestones[1]
+      milestone2.milestone_id.should == 2
+      milestone2.project_id.should == 1
+      milestone2.name.should == "Second milestone"
+      milestone2.item_ids.should == [ 6, 7, 8, 9, 10 ]
+    end
+    
+    should "show full milestones for project" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/milestone/list/?detail=full", "project-milestones-full.json")
+      milestones = @client.project_milestones(1, 'full')
+      milestones.length.should == 2
+      
+      milestone1 = milestones[0]
+      milestone1.created_at.should == Time.utc(2010,12,18, 14, 19, 8)
+      milestone1.updated_at.should == Time.utc(2010,12,18, 14, 19, 10)
+      milestone1.created_by.should == 2
+      milestone1.updated_by.should == nil
+      
+      milestone2 = milestones[1]
+      milestone2.created_at.should == Time.utc(2010,12,18, 14, 19, 8)
+      milestone2.updated_at.should == Time.utc(2010,12,18, 14, 19, 10)
+      milestone2.created_by.should == nil
+      milestone2.updated_by.should == nil
+      
+    end
+      
+    
+  end
+end

data/test/project_test.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class ProjectTest < Test::Unit::TestCase
+  
+  context "when authenticated" do
+    setup do
+      @client = PlayNicely::Client.new('robbiehudson', 'number42')
+    end
+    
+    should "return compact project info" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/show/?detail=compact", "project-compact.json")
+      project = @client.project(1)
+      project.project_id.should == 1
+      project.item_ids.should == [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+      project.user_ids == [ 1, 3 ]
+      project.milestone_ids == [1,2]
+      project.name.should == "Alan Parsons Project"
+    end
+    
+    should "return id for project" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/show/?detail=id", "project-id.json")
+      project = @client.project(1, "id")
+      project.should == 1
+    end
+    
+    should "return full project info" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/project/1/show/?detail=full", "project-full.json")
+      project = @client.project(1,"full")
+      project.project_id.should == 1
+      project.created_at.should == Time.utc(2010, 12, 14, 16, 3, 34)
+      project.updated_at.should == Time.utc(2010, 12, 14, 16, 3, 35)
+      project.created_by.should == 2
+      project.updated_by.should == 2
+    end
+  end
+end

data/test/user_test.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class UserTest < Test::Unit::TestCase
+  
+  context "when authenticated" do
+    setup do
+      @client = PlayNicely::Client.new('robbiehudson', 'number42')
+    end
+    
+    should "return compact user info" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/user/1/show/?detail=compact", "user-compact.json")
+      user = @client.user(1)
+      user.user_id.should == 1
+      user.username.should == 'adamcharnock'
+      user.first_name.should == 'Adam'
+      user.surname.should == 'Charnock'
+      user.image.should == 'http://app.playnice.ly/user/1/image/'
+    end
+    
+    should "return full user info" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/user/1/show/?detail=compact", "user-full.json")
+      user = @client.user(1)
+      user.user_id.should == 1
+      user.created_at.should == Time.utc(2010, 12, 16, 14, 44, 28)
+      user.updated_at.should == Time.utc(2010, 12, 16, 14, 44, 28)
+    end
+    
+    should "return compact current user info" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/user/current/show/?detail=compact", "user-compact.json")
+      user = @client.current_user()
+      user.user_id.should == 1
+      user.username.should == 'adamcharnock'
+      user.first_name.should == 'Adam'
+      user.surname.should == 'Charnock'
+      user.image.should == 'http://app.playnice.ly/user/1/image/'
+    end
+    
+    should "return full current user info" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/user/current/show/?detail=full", "user-full.json")
+      user = @client.current_user("full")
+      user.user_id.should == 1
+      user.created_at.should == Time.utc(2010, 12, 16, 14, 44, 28)
+      user.updated_at.should == Time.utc(2010, 12, 16, 14, 44, 28)
+    end
+    
+    should "return compact list of projects for user" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/user/1/project/list/?detail=compact", "user-projects-compact.json")
+      projects = @client.user_projects(1)
+      
+      project1 = projects[0]
+      project1.project_id.should == 1
+      project1.name.should == "Alan Parsons Project"
+      project1.item_ids.should == [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
+      project1.user_ids.should == [ 1, 3 ]
+      project1.milestone_ids.should == [ 1, 2 ]
+
+      project2 = projects[1]
+      project2.project_id.should == 2
+      project2.name.should == "The Bacon Street Project"
+      project2.item_ids.should == [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
+      project2.user_ids.should == [ 1, 4 ]
+      project2.milestone_ids.should == [ 1, 2 ]
+      
+    end
+    
+    should "return full list of projects for user" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/user/1/project/list/?detail=full", "user-projects-full.json")
+      projects = @client.user_projects(1,'full')
+      
+      project1 = projects[0]
+      project1.project_id.should == 1
+      
+      project2 = projects[1]
+      project2.project_id.should == 2
+    end
+    
+    should "return id list of projects for user" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/user/1/project/list/?detail=id", "user-projects-id.json")
+      projects = @client.user_projects(1, 'id')
+      projects.should == [1, 2, 3, 4]
+    end
+    
+    should "return compact list of projects for current user" do
+      stub_get("https://robbiehudson:number42@api.playnice.ly/v1/user/current/project/list/?detail=compact", "user-projects-compact.json")
+      projects = @client.current_user_projects()
+      
+      project1 = projects[0]
+      project1.project_id.should == 1
+      project1.name.should == "Alan Parsons Project"
+      project1.item_ids.should == [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
+      project1.user_ids.should == [ 1, 3 ]
+      project1.milestone_ids.should == [ 1, 2 ]
+
+      project2 = projects[1]
+      project2.project_id.should == 2
+      project2.name.should == "The Bacon Street Project"
+      project2.item_ids.should == [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
+      project2.user_ids.should == [ 1, 4 ]
+      project2.milestone_ids.should == [ 1, 2 ]
+    end
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification 
+name: playnicely
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Rob Hudson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-19 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-matchy
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 11
+        version: "2.11"
+  type: :development
+  version_requirements: *id007
+description: Simple wrapper for the PlayNicely API v1
+email: 
+- rob@playnice.ly
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.textile
+- Rakefile
+- lib/playnicely.rb
+- lib/playnicely/client.rb
+- lib/playnicely/version.rb
+- playnicely.gemspec
+- test/client_test.rb
+- test/fixtures/item-compact.json
+- test/fixtures/milestone-compact.json
+- test/fixtures/milestone-full.json
+- test/fixtures/project-compact.json
+- test/fixtures/project-full.json
+- test/fixtures/project-id.json
+- test/fixtures/project-items-compact.json
+- test/fixtures/project-items-id.json
+- test/fixtures/project-milestones-compact.json
+- test/fixtures/project-milestones-full.json
+- test/fixtures/project-milestones-id.json
+- test/fixtures/server-error.json
+- test/fixtures/user-compact.json
+- test/fixtures/user-full.json
+- test/fixtures/user-projects-compact.json
+- test/fixtures/user-projects-full.json
+- test/fixtures/user-projects-id.json
+- test/helper.rb
+- test/item_test.rb
+- test/milestone_test.rb
+- test/project_test.rb
+- test/user_test.rb
+has_rdoc: true
+homepage: http://github.com/playnicelyapp/playnicely-rb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Wrapper for the PlayNicely API
+test_files: []
+