agilezen 0.1.0

data/spec/fixtures/stories-page1.json

@@ -0,0 +1,71 @@
+{
+  "page": 1,
+  "pageSize": 3,
+  "totalPages": 4,
+  "totalItems": 10,
+  "items": [
+    {
+      "id": 1,
+      "text": "User registration",
+      "size": "2",
+      "color": "grey",
+      "ready": false,
+      "blocked": false,
+      "phase": {
+        "id": 87567,
+        "name": "Development"
+      },
+      "phaseIndex": 0,
+      "creator": {
+        "id": 19059,
+        "name": "Adam"
+      },
+      "owner": {
+        "id": 19059,
+        "name": "Adam"
+      }
+    },
+    {
+      "id": 2,
+      "text": "User sign in",
+      "size": "2",
+      "color": "grey",
+      "ready": false,
+      "blocked": false,
+      "phase": {
+        "id": 87566,
+        "name": "Ready"
+      },
+      "phaseIndex": 0,
+      "creator": {
+        "id": 19059,
+        "name": "Adam"
+      },
+      "owner": {
+        "id": 19059,
+        "name": "Adam"
+      }
+    },
+    {
+      "id": 3,
+      "text": "Create a post",
+      "size": "3",
+      "color": "grey",
+      "ready": false,
+      "blocked": false,
+      "phase": {
+        "id": 87565,
+        "name": "Backlog"
+      },
+      "phaseIndex": 0,
+      "creator": {
+        "id": 19059,
+        "name": "Adam"
+      },
+      "owner": {
+        "id": 19059,
+        "name": "Adam"
+      }
+    }
+  ]
+}

data/spec/fixtures/stories-page2.json

@@ -0,0 +1,71 @@
+{
+  "page": 2,
+  "pageSize": 3,
+  "totalPages": 4,
+  "totalItems": 10,
+  "items": [
+    {
+      "id": 4,
+      "text": "Add a post",
+      "size": "2",
+      "color": "grey",
+      "ready": false,
+      "blocked": false,
+      "phase": {
+        "id": 87565,
+        "name": "Backlog"
+      },
+      "phaseIndex": 1,
+      "creator": {
+        "id": 19059,
+        "name": "Adam"
+      },
+      "owner": {
+        "id": 19059,
+        "name": "Adam"
+      }
+    },
+    {
+      "id": 5,
+      "text": "Edit a post",
+      "size": "",
+      "color": "grey",
+      "ready": false,
+      "blocked": false,
+      "phase": {
+        "id": 87565,
+        "name": "Backlog"
+      },
+      "phaseIndex": 2,
+      "creator": {
+        "id": 19059,
+        "name": "Adam"
+      },
+      "owner": {
+        "id": 19059,
+        "name": "Adam"
+      }
+    },
+    {
+      "id": 6,
+      "text": "Delete a post",
+      "size": "",
+      "color": "grey",
+      "ready": false,
+      "blocked": false,
+      "phase": {
+        "id": 87565,
+        "name": "Backlog"
+      },
+      "phaseIndex": 3,
+      "creator": {
+        "id": 19059,
+        "name": "Adam"
+      },
+      "owner": {
+        "id": 19059,
+        "name": "Adam"
+      }
+    }
+  ]
+}

data/spec/fixtures/stories.json

@@ -0,0 +1,52 @@
+{
+  "page": 1,
+  "pageSize": 10,
+  "totalPages": 1,
+  "totalItems": 1,
+  "items": {
+    "story": [
+      {
+        "id": 1,
+        "text": "End world hunger",
+        "size": "large",
+        "color": "grey",
+        "ready": false,
+        "blocked": false,
+        "phase": {
+          "id": 1,
+          "name": "Backlog"
+        },
+        "phaseIndex": 0,
+        "creator": {
+          "id": 1,
+          "name": "John Doe"
+        },
+        "owner": {
+          "id": 2,
+          "name": "Jane Doe"
+        }
+      },
+      {
+        "id": 2,
+        "text": "Start world hunger",
+        "size": "large",
+        "color": "grey",
+        "ready": false,
+        "blocked": false,
+        "phase": {
+          "id": 1,
+          "name": "Backlog"
+        },
+        "phaseIndex": 0,
+        "creator": {
+          "id": 3,
+          "name": "Kill Bill"
+        },
+        "owner": {
+          "id": 4,
+          "name": "Dinjas"
+        }
+      }
+    ]
+  }
+}

data/spec/fixtures/story.json

@@ -0,0 +1,22 @@
+{
+  "id": 321,
+  "text": "Feed the children",
+  "size": "large",
+  "color": "grey",
+  "ready": false,
+  "blocked": true,
+  "reasonBlocked": "Need new ideas",
+  "phase": {
+    "id": 1,
+    "name": "Backlog"
+  },
+  "phaseIndex": 0,
+  "creator": {
+    "id": 1,
+    "name": "John Doe"
+  },
+  "owner": {
+    "id": 2,
+    "name": "Jane Doe"
+  }
+}

data/spec/fixtures/story/2-with-enrichments.json

@@ -0,0 +1,40 @@
+{
+  "id": 2,
+  "text": "User sign in",
+  "details": "The user should be able to sign in with either email or username.",
+  "size": "2",
+  "color": "grey",
+  "ready": false,
+  "blocked": false,
+  "phase": {
+    "id": 87566,
+    "name": "Ready"
+  },
+  "phaseIndex": 0,
+  "creator": {
+    "id": 19059,
+    "name": "Adam"
+  },
+  "owner": {
+    "id": 19059,
+    "name": "Adam"
+  },
+  "tags": [
+    {
+      "id": 81499,
+      "name": "sign-in"
+    },
+    {
+      "id": 81500,
+      "name": "user"
+    },
+    {
+      "id": 81501,
+      "name": "authentication"
+    }
+  ],
+  "metrics": {
+    "createTime": "/Date(1289217335000-0600)/",
+    "startTime": "/Date(1295607873000-0600)/"
+  }
+}

data/spec/fixtures/story/2-with-filtering.json

@@ -0,0 +1,35 @@
+{
+  "id": 2,
+  "text": "User sign in",
+  "size": "2",
+  "color": "grey",
+  "ready": false,
+  "blocked": false,
+  "phase": {
+    "id": 87566,
+    "name": "Ready"
+  },
+  "phaseIndex": 0,
+  "creator": {
+    "id": 19059,
+    "name": "Adam"
+  },
+  "owner": {
+    "id": 19059,
+    "name": "Adam"
+  },
+  "tags": [
+    {
+      "id": 81499,
+      "name": "sign-in"
+    },
+    {
+      "id": 81500,
+      "name": "user"
+    },
+    {
+      "id": 81501,
+      "name": "authentication"
+    }
+  ]
+}

data/spec/projects_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+require File.expand_path('../support/fakeweb_helper', __FILE__)
+
+describe AgileZen::Projects do
+  
+  before(:each) do
+    @client = AgileZen::Client.new(:api_key => 'testapikey')      
+  end
+  
+  describe "#projects" do
+    context "success" do
+      it "performs an API request for all projects" do
+        register_get('http://agilezen.com/api/v1/projects', 'projects.json')
+
+        response = @client.projects
+
+        response.projects.items.project.first.name.should eq('World Peace')
+      end
+      
+      it "allows filtering" do
+        register_get('http://agilezen.com/api/v1/projects?where=name%3ADiff', 'projects-with-filtering.json')
+
+        response = @client.projects(:where => 'name:Diff')
+        
+        response.items.first.name.should =~ /Diff/i
+      end
+    end
+  end
+  
+  describe "#project" do
+    context "success" do
+      it "performs an API request for a single project" do
+        register_get('http://agilezen.com/api/v1/project/123', 'project.json')
+
+        response = @client.project(123)
+
+        response.id.should eq(123)
+        response.name.should eq('Hippie Peace')
+      end
+      
+      it "includes enrichments" do
+        register_get('http://agilezen.com/api/v1/project/15404?with=details%2Cphases%2Cmembers%2Croles%2Cinvites%2Cmetrics', 'project/15404-with-enrichments.json')
+
+        response = @client.project(15404, :with => 'details,phases,members,roles,invites,metrics')
+        
+        response.details.should_not be_nil
+        response.phases.should_not be_nil
+        response.members.should_not be_nil
+        response.roles.should_not be_nil
+        response.invites.should_not be_nil
+        response.metrics.should_not be_nil
+      end
+    end
+    
+    context "failure" do
+      it "returns nil to indicate failure" do
+        register_get('http://agilezen.com/api/v1/project/99999', 'garbage.txt')
+
+        response = @client.project(99999)
+
+        response.should be_nil
+      end
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler"
+Bundler.setup
+
+require "rspec"
+require 'fakeweb'
+require "agilezen"
+# require "support/matchers"
+# 
+# Rspec.configure do |config|
+#   config.include AgileZen::Spec::Matchers
+# end

data/spec/stories_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+require File.expand_path('../support/fakeweb_helper', __FILE__)
+
+describe AgileZen::Stories do
+  
+  before(:each) do
+    @client = AgileZen::Client.new(:api_key => 'testapikey')      
+  end
+  
+  describe "#stories" do
+    context "success" do
+      it "performs an API request for all story of a given project" do
+        register_get('http://agilezen.com/api/v1/project/123/stories', 'stories.json')
+
+        response = @client.project_stories(123)
+
+        response.items.story.first.text.should eq('End world hunger')
+      end
+      
+      it "pages stories" do
+        register_get('http://agilezen.com/api/v1/project/15404/stories?page=1&pageSize=3', 'stories-page1.json')
+        register_get('http://agilezen.com/api/v1/project/15404/stories?page=2&pageSize=3', 'stories-page2.json')
+        
+        response1 = @client.project_stories(15404, :page => 1, :pageSize => 3)
+        response2 = @client.project_stories(15404, :page => 2, :pageSize => 3)
+        
+        response1.items.should_not eql(response2.items)
+      end
+    end
+    
+    context "failure" do
+      it "returns nil to indicate failure" do
+        register_get('http://agilezen.com/api/v1/project/99999/stories', 'garbage.txt')
+
+        response = @client.project_stories(99999)
+
+        response.should be_nil
+      end
+    end
+  end
+  
+  describe "#story" do
+    context "success" do
+      it "performs an API request for a single story of a given project" do
+        register_get('http://agilezen.com/api/v1/project/123/story/321', 'story.json')
+
+        response = @client.project_story(123, 321)
+
+        response.id.should eq(321)
+        response.text.should eq('Feed the children')
+      end
+      
+      it "includes enrichments" do
+        register_get('http://agilezen.com/api/v1/project/15404/story/2?with=details%2Ctags%2Cmetrics', 'story/2-with-enrichments.json')
+
+        response = @client.project_story(15404, 2, :with => 'details,tags,metrics')
+        
+        response.details.should_not be_nil
+        response.tags.should_not be_nil
+        response.metrics.should_not be_nil
+      end
+      
+      it "allows filtering" do
+        register_get('http://agilezen.com/api/v1/project/15404/story/2?where=tag%3Aauthentication&with=tags', 'story/2-with-filtering.json')
+
+        response = @client.project_story(15404, 2, :where => 'tag:authentication', :with => 'tags')
+        
+        response.id.should == 2
+        response.tags.detect { |t| t.name == 'authentication' }.should_not be_nil
+      end
+    end
+
+    context "failure" do
+      it "returns nil to indicate failure" do
+        register_get('http://agilezen.com/api/v1/project/99999/story/11111', 'garbage.txt')
+
+        response = @client.project_story(99999, 11111)
+
+        response.should be_nil
+      end
+    end
+  end
+  
+end