jiraby 0.0.1

data/spec/data/jira_projects.rb

@@ -0,0 +1,117 @@
+JIRA_2_PROJECT = {
+  "key" => "TST",
+  "name" => "Test",
+  "id" => "10000",
+  "self" => "http://localhost:8080/rest/api/2/project/TST",
+  "assigneeType" => "PROJECT_LEAD",
+  "components" => [],
+  "versions" => [],
+  "issueTypes" => [
+    {
+      "name" => "Bug",
+      "iconUrl" => "http://localhost:8080/images/icons/bug.gif",
+      "self" => "http://localhost:8080/rest/api/2/issuetype/1",
+      "id" => "1",
+      "subtask" => false,
+      "description" => "A problem which impairs or prevents the functions of the product.",
+    },
+    {
+      "name" => "New Feature",
+      "iconUrl" => "http://localhost:8080/images/icons/newfeature.gif",
+      "self" => "http://localhost:8080/rest/api/2/issuetype/2",
+      "id" => "2",
+      "subtask" => false,
+      "description" => "A new feature of the product, which has yet to be developed.",
+    },
+    {
+      "name" => "Task",
+      "iconUrl" => "http://localhost:8080/images/icons/task.gif",
+      "self" => "http://localhost:8080/rest/api/2/issuetype/3",
+      "id" => "3",
+      "subtask" => false,
+      "description" => "A task that needs to be done.",
+    },
+    {
+      "name" => "Improvement",
+      "iconUrl" => "http://localhost:8080/images/icons/improvement.gif",
+      "self" => "http://localhost:8080/rest/api/2/issuetype/4",
+      "id" => "4",
+      "subtask" => false,
+      "description" => "An improvement or enhancement to an existing feature or task.",
+    },
+    {
+      "name" => "Sub-task",
+      "iconUrl" => "http://localhost:8080/images/icons/issue_subtask.gif",
+      "self" => "http://localhost:8080/rest/api/2/issuetype/5",
+      "id" => "5",
+      "subtask" => true,
+      "description" => "The sub-task of the issue",
+    },
+  ],
+  "avatarUrls" => {
+    "48x48" => "http://localhost:8080/secure/projectavatar?pid=10000&avatarId=10011",
+    "16x16" => "http://localhost:8080/secure/projectavatar?size=small&pid=10000&avatarId=10011",
+  },
+  "roles" => {
+    "Developers" => "http://localhost:8080/rest/api/2/project/TST/role/10001",
+    "Administrators" => "http://localhost:8080/rest/api/2/project/TST/role/10002",
+    "Users" => "http://localhost:8080/rest/api/2/project/TST/role/10000",
+  },
+  "lead" => {
+    "name" => "admin",
+    "self" => "http://localhost:8080/rest/api/2/user?username=admin",
+    "displayName" => "Administrator",
+    "active" => true,
+    "avatarUrls" => {
+      "48x48" => "http://localhost:8080/secure/useravatar?avatarId=10122",
+      "16x16" => "http://localhost:8080/secure/useravatar?size=small&avatarId=10122",
+    },
+  },
+}
+
+JIRA_2_ALPHA_PROJECT = {
+  "key" => "TST",
+  "name" => "Test",
+  "self" => "http://localhost:8080/rest/api/2.0.alpha1/project/TST",
+  "assigneeType" => "PROJECT_LEAD",
+  "components" => [],
+  "versions" => [],
+  "issueTypes" => [
+    {
+      "name" => "Bug",
+      "self" => "http://localhost:8080/rest/api/2.0.alpha1/issueType/1",
+      "subtask" => false,
+    },
+    {
+      "name" => "New Feature",
+      "self" => "http://localhost:8080/rest/api/2.0.alpha1/issueType/2",
+      "subtask" => false,
+    },
+    {
+      "name" => "Task",
+      "self" => "http://localhost:8080/rest/api/2.0.alpha1/issueType/3",
+      "subtask" => false,
+    },
+    {
+      "name" => "Improvement",
+      "self" => "http://localhost:8080/rest/api/2.0.alpha1/issueType/4",
+      "subtask" => false,
+    },
+    {
+      "name" => "Sub-task",
+      "self" => "http://localhost:8080/rest/api/2.0.alpha1/issueType/5",
+      "subtask" => true,
+    },
+  ],
+  "roles" => {
+    "Developers" => "http://localhost:8080/rest/api/2.0.alpha1/project/TST/role/10001",
+    "Administrators" => "http://localhost:8080/rest/api/2.0.alpha1/project/TST/role/10002",
+    "Users" => "http://localhost:8080/rest/api/2.0.alpha1/project/TST/role/10000",
+  },
+  "lead" => {
+    "name" => "admin",
+    "self" => "http://localhost:8080/rest/api/2.0.alpha1/user?username=admin",
+    "displayName" => "Administrator",
+    "active" => true,
+  },
+}

data/spec/data/project_TST.json

@@ -0,0 +1,97 @@
+{
+  "self": "http://www.example.com/jira/rest/api/2/project/TST",
+  "id": "10000",
+  "key": "TST",
+  "description": "This project was created as an example for REST.",
+  "lead": {
+    "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+    "name": "fred",
+    "avatarUrls": {
+      "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
+      "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
+      "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred",
+      "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"
+    },
+    "displayName": "Fred F. User",
+    "active": false
+  },
+  "components": [
+    {
+      "self": "http://www.example.com/jira/rest/api/2/component/10000",
+      "id": "10000",
+      "name": "Component 1",
+      "description": "This is a JIRA component",
+      "lead": {
+        "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+        "name": "fred",
+        "avatarUrls": {
+          "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
+          "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
+          "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred",
+          "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"
+        },
+        "displayName": "Fred F. User",
+        "active": false
+      },
+      "assigneeType": "PROJECT_LEAD",
+      "assignee": {
+        "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+        "name": "fred",
+        "avatarUrls": {
+          "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
+          "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
+          "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred",
+          "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"
+        },
+        "displayName": "Fred F. User",
+        "active": false
+      },
+      "realAssigneeType": "PROJECT_LEAD",
+      "realAssignee": {
+        "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+        "name": "fred",
+        "avatarUrls": {
+          "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
+          "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
+          "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred",
+          "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred"
+        },
+        "displayName": "Fred F. User",
+        "active": false
+      },
+      "isAssigneeTypeValid": false
+    }
+  ],
+  "issueTypes": [
+    {
+      "self": "http://localhost:8090/jira/rest/api/2.0/issueType/3",
+      "id": "3",
+      "description": "A task that needs to be done.",
+      "iconUrl": "http://localhost:8090/jira/images/icons/issuetypes/task.png",
+      "name": "Task",
+      "subtask": false
+    },
+    {
+      "self": "http://localhost:8090/jira/rest/api/2.0/issueType/1",
+      "id": "1",
+      "description": "A problem with the software.",
+      "iconUrl": "http://localhost:8090/jira/images/icons/issuetypes/bug.png",
+      "name": "Bug",
+      "subtask": false
+    }
+  ],
+  "url": "http://www.example.com/jira/browse/TST",
+  "email": "from-jira@example.com",
+  "assigneeType": "PROJECT_LEAD",
+  "versions": [],
+  "name": "Example",
+  "roles": {
+    "Developers": "http://www.example.com/jira/rest/api/2/project/TST/role/10000"
+  },
+  "avatarUrls": {
+    "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
+    "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
+    "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000",
+    "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000"
+  }
+}

data/spec/data/search_results.json

@@ -0,0 +1,26 @@
+{
+  "expand": "names,schema",
+  "startAt": 0,
+  "maxResults": 50,
+  "total": 3,
+  "issues": [
+    {
+      "key": "TST-1",
+      "id": "1001",
+      "self": "http://www.example.com/jira/rest/api/2/issue/1001",
+      "expand": ""
+    },
+    {
+      "key": "TST-2",
+      "id": "1002",
+      "self": "http://www.example.com/jira/rest/api/2/issue/1002",
+      "expand": ""
+    },
+    {
+      "key": "TST-3",
+      "id": "1003",
+      "self": "http://www.example.com/jira/rest/api/2/issue/1003",
+      "expand": ""
+    }
+  ]
+}

data/spec/entity_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'spec_helper'
+
+describe Jiraby::Entity do
+  before(:each) do
+    @ent = Jiraby::Entity.new(json_data('issue_10002.json'))
+  end
+
+  describe '#key' do
+    it "passes through to Hash#key if arguments are included" do
+      @ent.key('10002').should == 'id'
+      @ent.key('TST-1').should == 'key'
+    end
+
+    it "returns the value in the issue's `key` field if argument is omitted" do
+      @ent.key.should == 'TST-1'
+    end
+  end
+
+end
+

data/spec/issue_spec.rb

@@ -0,0 +1,289 @@
+require_relative 'spec_helper'
+require_relative 'data/jira_issues'
+
+describe Jiraby::Issue do
+  before(:each) do
+    @field_mapping = {
+      'description' => 'Description',
+      'customfield_10001' => 'Custom Field',
+    }
+    @jira = Jiraby::Jira.new('jira.example.com', 'username', 'password')
+    @jira.stub(:field_mapping => @field_mapping)
+    @issue = Jiraby::Issue.new(@jira, json_data('issue_10002.json'))
+  end
+
+  context "Class methods" do
+  end # Class methods
+
+  context "Instance methods" do
+    describe '#initialize' do
+      it "accepts a JSON hash structure" do
+        json = json_data('issue_10002.json')
+        issue = Jiraby::Issue.new(@jira, json)
+        issue.data.should == json
+      end
+    end
+
+    describe "#[]" do
+      it "accepts field `id`" do
+        @issue['description'].should == "example bug report"
+      end
+
+      it "accepts field `name`" do
+        @issue['Custom Field'].should == "custom field value"
+      end
+
+      it "returns the value set by `#[]=`" do
+        @issue['description'] = "Foobar"
+        @issue['description'].should == "Foobar"
+      end
+
+      it "raises an exception on invalid field name" do
+        lambda do
+          @issue['bogus']
+        end.should raise_error(
+          Jiraby::InvalidField, /Invalid field name or ID: bogus/)
+      end
+    end
+
+    describe "#[]=" do
+      it "accepts field `id`" do
+        @issue['description'] = "Foobar"
+        @issue.pending_changes['description'].should == "Foobar"
+      end
+
+      it "accepts field `name`" do
+        @issue['Custom Field'] = "Modified"
+        @issue.pending_changes[@field_mapping.key('Custom Field')].should == "Modified"
+      end
+
+      it "raises an exception on invalid field name" do
+        lambda do
+          @issue['bogus'] = "Modified"
+        end.should raise_error(
+          Jiraby::InvalidField, /Invalid field name or ID: bogus/)
+      end
+    end
+
+    describe "#field_id" do
+      before(:each) do
+        @ids_and_names = {
+          'description' => 'Description',
+          'sub-tasks' => 'Sub-Tasks',
+          'project' => 'Project',
+        }
+        @jira.stub(:field_mapping => @ids_and_names)
+      end
+
+      it "returns ID as-is" do
+        @ids_and_names.keys.each do |id|
+          @issue.field_id(id).should == id
+        end
+      end
+
+      it "returns the ID for a given name" do
+        @ids_and_names.each do |id, name|
+          @issue.field_id(name).should == id
+        end
+      end
+
+      it "raises an exception when invalid name or ID is given" do
+        lambda do
+          @issue.field_id("Completely Bogus")
+        end.should raise_error(/Invalid field name or ID/)
+      end
+    end
+
+    describe "#key" do
+      it "returns nil if the key is undefined" do
+        issue = Jiraby::Issue.new(@jira, {})
+        issue.key.should be_nil
+      end
+
+      it "returns the key field from the issue's data" do
+        @issue.key.should == @issue.data['key']
+      end
+    end
+
+    describe "#editmeta" do
+      it "requests editmeta for the current issue" do
+        @jira.should_receive(:get).
+          with("issue/#{@issue.key}/editmeta").
+          and_return({})
+        @issue.editmeta
+      end
+    end
+
+    describe "#pending_changes?" do
+      it "returns true if updates are pending" do
+        @issue["description"] = "Foo"
+        @issue.pending_changes?.should be_true
+      end
+
+      it "returns false if no updates are pending" do
+        @issue.pending_changes?.should be_false
+      end
+    end
+
+    describe "#save!" do
+      it "sends a PUT request to Jira with updates" do
+        @issue['description'] = "Modified description"
+        expect_fields = {
+          'fields' => @issue.pending_changes
+        }
+        @jira.should_receive(:put).
+          with("issue/#{@issue.key}", expect_fields)
+        @issue.save!
+      end
+
+      it "updates the data attribute with the new changes" do
+        @jira.stub(:put)
+        original_description = @issue['description']
+        modified_description = "Modified description"
+
+        @issue.data.fields.description.should == original_description
+        @issue['description'] = modified_description
+        @issue.save!
+        @issue.data.fields.description.should == modified_description
+      end
+
+      it "resets pending_changes" do
+        @jira.stub(:put => nil)
+        @issue['description'] = "Modified description"
+        @issue.pending_changes.should_not be_empty
+        @issue.pending_changes?.should be_true
+        @issue.save!
+        @issue.pending_changes.should be_empty
+        @issue.pending_changes?.should be_false
+      end
+    end
+
+    describe "#has_field?" do
+      before(:each) do
+        @ids_and_names = {
+          'description' => 'Description',
+          'sub-tasks' => 'Sub-Tasks',
+          'project' => 'Project',
+        }
+        @jira.stub(:field_mapping => @ids_and_names)
+      end
+
+      it "true when issue has a field with the given ID" do
+        @ids_and_names.keys.each do |id|
+          @issue.has_field?(id).should be_true
+        end
+      end
+
+      it "true when issue has a field with the given name" do
+        @ids_and_names.values.each do |name|
+          @issue.has_field?(name).should be_true
+        end
+      end
+
+      it "false when issue has a no field with the given ID or name" do
+        @issue.has_field?("Completely Bogus").should be_false
+      end
+    end #has_field?
+
+    describe "#is_subtask?" do
+      it "true when issuetype.subtask is true" do
+        data = { 'fields' => { 'issuetype' => {'subtask' => true} } }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.is_subtask?.should be_true
+      end
+
+      it "false when issuetype.subtask is false" do
+        data = { 'fields' => { 'issuetype' => {'subtask' => false} } }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.is_subtask?.should be_false
+      end
+
+      it "false when issuetype.subtask is not set" do
+        data = { 'fields' => { 'issuetype' => {} } }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.is_subtask?.should be_false
+      end
+    end #is_subtask?
+
+    describe "#is_assigned?" do
+      it "true when assignee is set" do
+        data = { 'fields' => { 'assignee' => {'name' => 'someone'} } }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.is_assigned?.should be_true
+      end
+
+      it "false when assignee is nil" do
+        data = { 'fields' => { 'assignee' => nil } }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.is_assigned?.should be_false
+      end
+    end #is_assigned?
+
+    describe "#parent" do
+      it "returns the parent key when issue is a subtask" do
+        parent_key = 'FOO-234'
+        data = {
+          'fields' => {
+            'parent' => {'key' => parent_key},
+            'issuetype' => {'subtask' => true},
+          }
+        }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.parent.should == parent_key
+      end
+
+      it "returns nil when issue is not a subtask" do
+        data = {
+          'fields' => {
+            'issuetype' => {'subtask' => false},
+          }
+        }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.parent.should be_nil
+      end
+    end #parent
+
+    describe "#subtasks" do
+      it "returns an array of subtask keys" do
+        subtask_keys = ['ST-01', 'ST-02', 'ST-03']
+        data = {
+          'fields' => {
+            'subtasks' => [
+              {'key' => 'ST-01'},
+              {'key' => 'ST-02'},
+              {'key' => 'ST-03'},
+            ]
+          }
+        }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.subtasks.should == subtask_keys
+      end
+
+      it "returns an empty array if the issue has no subtasks" do
+        data = {
+          'fields' => {
+            'subtasks' => []
+          }
+        }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.subtasks.should == []
+      end
+    end #subtasks
+
+    describe "#field_ids" do
+      it "returns a sorted array of the issue's field IDs" do
+        data = {
+          'fields' => {
+            'foo' => 'x',
+            'bar' => 'y',
+            'baz' => 'z',
+          }
+        }
+        issue = Jiraby::Issue.new(@jira, data)
+        issue.field_ids.should == ['bar', 'baz', 'foo']
+      end
+    end #field_ids
+
+  end # Instance methods"
+end
+