jiralicious 0.0.6

data/lib/jiralicious/version.rb

@@ -0,0 +1,3 @@
+module Jiralicious
+  VERSION = "0.0.6"
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Jiralicious::Configuration do
+  before :each do
+    Jiralicious.reset
+  end
+
+  it "sets the options to their default value" do
+    Jiralicious.username.should be_nil
+    Jiralicious.password.should be_nil
+    Jiralicious.uri.should be_nil
+    Jiralicious.api_version.should == "latest"
+  end
+
+  it "allows setting of options in a block" do
+    Jiralicious.configure do |config|
+      config.username = "jstewart"
+      config.password = "derp"
+      config.uri = "http://example.com/foo/bar"
+      config.api_version = "2.0aplha"
+    end
+
+    Jiralicious.username.should == "jstewart"
+    Jiralicious.password.should == "derp"
+    Jiralicious.uri = "http://example.com/foo/bar"
+    Jiralicious.api_version = "2.0aplha"
+  end
+end

data/spec/field_parser_spec.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class ParserMock
+  include Jiralicious::Parsers::FieldParser
+
+  def initialize(parsed)
+    parse!(parsed)
+  end
+end
+
+describe Jiralicious::Parsers::FieldParser do
+  context "parse!" do
+    before :each do
+      @parsed_data = {
+        "testfield" => {"name" => "testfield", "value"  => "Test Data"},
+        "methods" => {"name" => "methods", "value" => "Test Data 2"},
+        "testField" => {"name" => "testField", "value" => "Test Data 3"},
+        "test_field_dash" => {"name" => "test-field-dash", "value" => "Test Data 4"},
+        "test_field_space" => {"name" => "test field space", "value" => "Test Data 5"},
+        "test_field_hash" => {"name" => "test_field_hash", "value" => {"it" => "is a Hash"}},
+        "test_field_array" => {"name" => "test_field_array", "value" => ["Not a hash"]},
+        "test_field_array_with_hash" => {"name" => "test_field_array_with_hash",
+          "value" => [{"try" => "this"}]}
+      }
+      @parsed_class = ParserMock.new(@parsed_data)
+    end
+
+    it "raises an error when a hash is not passed in" do
+      lambda { ParserMock.new }.should raise_error(ArgumentError)
+    end
+
+    it "creates a hash to store data from the fields internally" do
+      @parsed_class.instance_variable_get("@jiralicious_field_parser_data").
+        should be_instance_of(Hash)
+    end
+
+    context "defining methods" do
+      it "defines getter methods on the object it's called in" do
+        @parsed_class.testfield.should == "Test Data"
+      end
+
+      it "prefixes a defined method with jira_ when the method already exists" do
+        @parsed_class.jira_methods.should == "Test Data 2"
+      end
+
+      it "downcases java idiom method names" do
+        @parsed_class.test_field.should == "Test Data 3"
+      end
+
+      it "converts nonword  to underscore" do
+        @parsed_class.test_field_dash.should == "Test Data 4"
+        @parsed_class.test_field_space.should == "Test Data 5"
+      end
+    end
+
+    context "mashifying data" do
+      it "makes hashes a mash" do
+        @parsed_class.test_field_hash.should be_instance_of(Hashie::Mash)
+      end
+
+      it "recursively makes array elements mashes" do
+        @parsed_class.test_field_array_with_hash.
+          first.should be_instance_of(Hashie::Mash)
+      end
+
+      it "leaves array data alone when it's not a hash" do
+        @parsed_class.test_field_array.should == ["Not a hash"]
+      end
+    end
+  end
+end

data/spec/fixtures/issue.json

@@ -0,0 +1,167 @@
+{
+  "expand": "html",
+  "self": "http://example.com:8080/jira/rest/api/2.0/issue/EX-1",
+  "key": "EX-1",
+  "fields": {
+    "sub-tasks": {
+      "name": "sub-tasks",
+      "type": "issuelinks",
+      "value": [
+        {
+          "issueKey": "EX-2",
+          "issue": "http://example.com:8080/jira/rest/api/2.0/issue/EX-2",
+          "type": {
+            "name": "Sub-task",
+            "direction": "OUTBOUND"
+          }
+        }
+      ]
+    },
+    "timetracking": {
+      "name": "timetracking",
+      "type": "timetracking",
+      "value": {
+        "timeoriginalestimate": 10,
+        "timeestimate": 3,
+        "timespent": 6
+      }
+    },
+    "project": {
+      "name": "project",
+      "type": "com.atlassian.jira.project.Project",
+      "value": {
+        "self": "http://www.example.com/jira/rest/api/2.0/project/EX",
+        "key": "EX",
+        "name": "Example"
+      }
+    },
+    "updated": {
+      "name": "updated",
+      "type": "java.util.Date",
+      "value": 1
+    },
+    "description": {
+      "name": "description",
+      "type": "java.lang.String",
+      "value": "example bug report"
+    },
+    "links": {
+      "name": "links",
+      "type": "issuelinks",
+      "value": [
+        {
+          "issueKey": "PRJ-2",
+          "issue": "http://example.com:8080/jira/rest/api/2.0/issue/PRJ-2",
+          "type": {
+            "name": "Dependent",
+            "direction": "OUTBOUND",
+            "description": "depends on"
+          }
+        },
+        {
+          "issueKey": "PRJ-3",
+          "issue": "http://example.com:8080/jira/rest/api/2.0/issue/PRJ-3",
+          "type": {
+            "name": "Dependent",
+            "direction": "INBOUND",
+            "description": "is depended by"
+          }
+        }
+      ]
+    },
+    "attachment": {
+      "name": "attachment",
+      "type": "attachment",
+      "value": [
+        {
+          "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000",
+          "filename": "picture.jpg",
+          "author": {
+            "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
+            "name": "fred",
+            "displayName": "Fred F. User",
+            "active": false
+          },
+          "created": "2011-07-25T06:31:08.307-0500",
+          "size": 23123,
+          "mimeType": "image/jpeg",
+          "content": "http://www.example.com/jira/attachments/10000",
+          "thumbnail": "http://www.example.com/jira/secure/thumbnail/10000"
+        }
+      ]
+    },
+    "watcher": {
+      "name": "watcher",
+      "type": "watcher",
+      "value": {
+        "self": "http://www.example.com/jira/rest/api/2.0/issue/EX-1/watchers",
+        "isWatching": false,
+        "watchCount": 1,
+        "watchers": [
+          {
+            "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
+            "name": "fred",
+            "displayName": "Fred F. User",
+            "active": false
+          }
+        ]
+      }
+    },
+    "comment": {
+      "name": "comment",
+      "type": "java.lang.String",
+      "value": [
+        {
+          "self": "http://example.com:8080/jira/rest/api/2.0/comment/10000",
+          "author": {
+            "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
+            "name": "fred",
+            "displayName": "Fred F. User",
+            "active": false
+          },
+          "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
+          "updateAuthor": {
+            "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
+            "name": "fred",
+            "displayName": "Fred F. User",
+            "active": false
+          },
+          "created": "2011-07-25T06:31:08.311-0500",
+          "updated": "2011-07-25T06:31:08.311-0500",
+          "visibility": {
+            "type": "ROLE",
+            "value": "Administrators"
+          }
+        }
+      ]
+    },
+    "worklog": {
+      "name": "worklog",
+      "type": "worklog",
+      "value": [
+        {
+          "self": "http://www.example.com/jira/rest/api/2.0/worklog/10000",
+          "author": {
+            "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
+            "name": "fred",
+            "displayName": "Fred F. User",
+            "active": false
+          },
+          "updateAuthor": {
+            "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
+            "name": "fred",
+            "displayName": "Fred F. User",
+            "active": false
+          },
+          "comment": "I did some work here.",
+          "visibility": {
+            "type": "GROUP",
+            "value": "jira-developers"
+          },
+          "started": "2011-07-25T06:31:08.314-0500",
+          "minutesSpent": 180
+        }
+      ]
+    }
+  }
+}

data/spec/fixtures/search.json

@@ -0,0 +1,11 @@
+{
+    "startAt": 0,
+    "maxResults": 50,
+    "total": 1,
+    "issues": [
+        {
+            "self": "http://www.example.com/jira/rest/api/2.0/jira/rest/api/2.0/issue/HSP-1",
+            "key": "HSP-1"
+        }
+    ]
+}

data/spec/fixtures/transitions.json

@@ -0,0 +1,65 @@
+{
+    "2": {
+        "name": "Close Issue",
+        "fields": [{
+            "id": "resolution",
+            "required": true,
+            "type": "com.atlassian.jira.issue.resolution.Resolution"
+        },
+        {
+            "id": "fixVersions",
+            "required": false,
+            "type": "com.atlassian.jira.project.version.Version"
+        },
+        {
+            "id": "customfield_10105",
+            "required": false,
+            "type": "com.atlassian.jira.plugins.jira-importers-plugin:bug-importid"
+        },
+        {
+            "id": "customfield_10106",
+            "required": false,
+            "type": "com.atlassian.jira.plugin.system.customfieldtypes:textfield"
+        },
+        {
+            "id": "assignee",
+            "required": false,
+            "type": "com.opensymphony.user.User"
+        }],
+        "transitionDestination": "6"
+    },
+    "4": {
+        "name": "Start Progress",
+        "fields": [],
+        "transitionDestination": "3"
+    },
+    "5": {
+        "name": "Resolve Issue",
+        "fields": [{
+            "id": "resolution",
+            "required": true,
+            "type": "com.atlassian.jira.issue.resolution.Resolution"
+        },
+        {
+            "id": "fixVersions",
+            "required": false,
+            "type": "com.atlassian.jira.project.version.Version"
+        },
+        {
+            "id": "customfield_10105",
+            "required": false,
+            "type": "com.atlassian.jira.plugins.jira-importers-plugin:bug-importid"
+        },
+        {
+            "id": "customfield_10106",
+            "required": false,
+            "type": "com.atlassian.jira.plugin.system.customfieldtypes:textfield"
+        },
+        {
+            "id": "assignee",
+            "required": false,
+            "type": "com.opensymphony.user.User"
+        }],
+        "transitionDestination": "5"
+    }
+}

data/spec/issue_spec.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Jiralicious::Issue, "finding" do
+
+  before :each do
+    Jiralicious.configure do |config|
+      config.username = "jstewart"
+      config.password = "topsecret"
+      config.uri = "http://localhost"
+      config.api_version = "latest"
+    end
+
+    FakeWeb.register_uri(:get,
+                         "#{Jiralicious.rest_path}/issue/EX-1",
+                         :status => "200",
+                         :body => issue_json)
+  end
+
+  it "finds the issue by key" do
+    Jiralicious::Issue.find("EX-1").should be_instance_of(Jiralicious::Issue)
+    issue = Jiralicious::Issue.find("EX-1")
+  end
+
+  it "raises an exception when the issue can't be found or can't be viewed" do
+    lambda {
+      FakeWeb.register_uri(:get,
+                           "#{Jiralicious.rest_path}/issue/EX-1",
+                           :status => ["404" "Not Found"])
+      Jiralicious::Issue.find("EX-1")
+    }.should raise_error(Jiralicious::IssueNotFound)
+  end
+
+  it "translates the JSON properly" do
+    issue = Jiralicious::Issue.find("EX-1")
+    issue.jira_key.should == "EX-1"
+    issue.jira_self.should == "http://example.com:8080/jira/rest/api/2.0/issue/EX-1"
+  end
+end
+
+
+describe Jiralicious::Issue, "transitions" do
+
+  before :each do
+    Jiralicious.configure do |config|
+      config.username = "jstewart"
+      config.password = "topsecret"
+      config.uri = "http://localhost"
+      config.api_version = "latest"
+    end
+
+  end
+
+  it "returns list of possible transitions" do
+    FakeWeb.register_uri(:get,
+                         "#{Jiralicious.rest_path}/issue/EX-1/transitions",
+                         :status => "200",
+                         :body => transitions_json)
+
+    transitions = Jiralicious::Issue.get_transitions("#{Jiralicious.rest_path}/issue/EX-1/transitions")
+    transitions.should be_instance_of(Hash)
+  end
+
+  it "performs transition" do
+    FakeWeb.register_uri(:post,
+                         "#{Jiralicious.rest_path}/issue/EX-1/transitions",
+                         :status => "204",
+                         :body => nil)
+
+    result = Jiralicious::Issue.transition("#{Jiralicious.rest_path}/issue/EX-1/transitions",
+                                  {"transition" => "3", "fields" => []})
+    result.should be_empty
+  end
+
+  it "raises an exception on transition failure" do
+    FakeWeb.register_uri(:post,
+                         "#{Jiralicious.rest_path}/issue/EX-1/transitions",
+                         :status => "400",
+                         :body => %q{{"errorMessages":["Workflow operation is not valid"],"errors":{}}})
+    lambda {
+      result = Jiralicious::Issue.transition("#{Jiralicious.rest_path}/issue/EX-1/transitions",
+                                    {"transition" => "invalid"})
+    }.should raise_error(Jiralicious::TransitionError)
+  end
+
+  it "raises an IssueNotFound exception if issue is not found" do
+    FakeWeb.register_uri(:post,
+                         "#{Jiralicious.rest_path}/issue/EX-1/transitions",
+                         :status => "404",
+                         :body => %q{{"errorMessages":["Issue Does Not Exist"],"errors":{}}})
+    lambda {
+      result = Jiralicious::Issue.transition("#{Jiralicious.rest_path}/issue/EX-1/transitions",
+                                    {"transition" => "invalid"})
+    }.should raise_error(Jiralicious::IssueNotFound)
+  end
+end