jira_client 1.0.0

data/lib/jira_client/base.rb

@@ -0,0 +1,54 @@
+require "jira_client/core_ext/string"
+
+module JiraClient
+  class Base
+    class << self
+      # Initialize class variable if not set
+      def conversions
+        @conversions ||= {}
+      end
+
+      def convert(attribute, conversion)
+        if conversion.instance_of? Proc
+          conversions[attribute] = conversion
+        elsif conversion < JiraClient::Base
+          conversions[attribute] = lambda {|v| conversion.from_response(v)}
+        end
+      end
+
+      def attr_reader(*attrs)
+        mod = Module.new do
+          attrs.each do |attribute|
+            define_method attribute do
+              @attrs[attribute.to_sym]
+            end
+            define_method "#{attribute}?" do
+              !!@attrs[attribute.to_sym]
+            end
+          end
+        end
+        include mod
+      end
+
+      def from_response(attrs={})
+        return unless attrs
+        new(attrs)
+      end
+
+    end
+
+    def initialize(attrs={})
+      self.class.conversions.each do |key, value|
+        if attrs.has_key? key
+          if attrs[key].kind_of? Array
+            attrs[key] = attrs[key].map {|elem| value.call(elem)}
+          else
+            attrs[key] = value.call(attrs[key])
+          end
+        end
+      end
+      @attrs = attrs
+    end
+
+  end
+end

data/lib/jira_client/comment.rb

@@ -0,0 +1,12 @@
+require "jira_client/user"
+
+module JiraClient
+  class Comment < JiraClient::Base
+    attr_reader :id, :author, :body, :update_author, :created, :updated
+
+    convert :author, JiraClient::User
+    convert :update_author, JiraClient::User
+    convert :created, lambda {|value| DateTime.parse(value)}
+    convert :updated, lambda {|value| DateTime.parse(value)}
+  end
+end

data/lib/jira_client/configuration.rb

@@ -0,0 +1,27 @@
+module JiraClient
+  class Configuration
+    attr_accessor :base_url, :api_path, :port, :proxy, :username, :password, :certificate, :certificate_passphrase
+
+    def initialize
+      @base_url = nil
+      @port = nil
+      @proxy = nil
+      @api_path = "/rest/api/2"
+      @username = nil
+      @password = nil
+      @certificate = nil
+      @certificate_passphrase = nil
+    end
+
+    def full_url
+      if @base_url.nil? or @api_path.nil?
+        raise JiraClient::Error::ConfigurationError, "Invalid configuration. Run JiraClient.configure."
+      end
+      result = @base_url.gsub(/\/\z/, '')
+      result += ":#{@port}" unless @port.nil?
+      result += @api_path
+      result
+    end
+
+  end
+end

data/lib/jira_client/core_ext/string.rb

@@ -0,0 +1,7 @@
+class String
+
+  def underscore
+    self.gsub(/::/, '/').gsub(/([a-z]+)([A-Z])/, '\1_\2').gsub(/([a-z\d])([A-Z])/, '\1\2').tr("-", "_").downcase
+  end
+
+end

data/lib/jira_client/error/bad_request.rb

@@ -0,0 +1,5 @@
+module JiraClient
+  module Error
+    class BadRequest < StandardError; end
+  end
+end

data/lib/jira_client/error/configuration_error.rb

@@ -0,0 +1,5 @@
+module JiraClient
+  module Error
+    class ConfigurationError < ::ArgumentError; end
+  end
+end

data/lib/jira_client/error/issue_error.rb

@@ -0,0 +1,5 @@
+module JiraClient
+  module Error
+    class IssueError < StandardError; end
+  end
+end

data/lib/jira_client/error/resource_not_found.rb

@@ -0,0 +1,5 @@
+module JiraClient
+  module Error
+    class ResourceNotFound < StandardError; end
+  end
+end

data/lib/jira_client/error/unauthorized.rb

@@ -0,0 +1,5 @@
+module JiraClient
+  module Error
+    class Unauthorized < StandardError; end
+  end
+end

data/lib/jira_client/issue.rb

@@ -0,0 +1,26 @@
+require "jira_client/status"
+require "jira_client/timetracking"
+require "jira_client/project"
+require "jira_client/worklog"
+
+module JiraClient
+  class Issue < JiraClient::Base
+    attr_reader :key, :description, :summary, :status, :timetracking, :project, :worklog, :comment
+
+    convert :status, JiraClient::Status
+    convert :timetracking, JiraClient::Timetracking
+    convert :comment, JiraClient::Comment
+    convert :project, JiraClient::Project
+    convert :worklog, JiraClient::Worklog
+
+    class << self
+
+      def from_response(params)
+        # Make values nested in the :fields key top-level values
+        params.merge!(params[:fields]).delete :fields if params.has_key? :fields
+        super(params)
+      end
+
+    end
+  end
+end

data/lib/jira_client/project.rb

@@ -0,0 +1,5 @@
+module JiraClient
+  class Project < JiraClient::Base
+    attr_reader :name, :key
+  end
+end

data/lib/jira_client/server_info.rb

@@ -0,0 +1,11 @@
+require "time"
+require "jira_client/base"
+
+module JiraClient
+  class ServerInfo < JiraClient::Base
+    attr_reader :version, :base_url, :build_number, :build_date, :server_title, :server_time
+
+    convert :server_time, lambda {|value| Time.parse(value)}
+    convert :build_date, lambda {|value| Time.parse(value)}
+  end
+end

data/lib/jira_client/status.rb

@@ -0,0 +1,7 @@
+module JiraClient
+  class Status < JiraClient::Base
+    OPEN = 1; CLOSE = 2; START_PROGRESS = 4; REOPEN = 3; RESOLVE = 5;
+
+    attr_reader :id, :name, :description
+  end
+end

data/lib/jira_client/timetracking.rb

@@ -0,0 +1,6 @@
+module JiraClient
+  class Timetracking < JiraClient::Base
+    attr_reader :original_estimate, :remaining_estimate, :time_spent, :original_estimate_seconds,
+                :remaining_estimate_seconds, :time_spent_seconds
+  end
+end

data/lib/jira_client/user.rb

@@ -0,0 +1,10 @@
+module JiraClient
+  class User < JiraClient::Base
+    attr_reader :display_name, :email_address, :name
+
+    def active?
+      @attrs[:active] == true
+    end
+
+  end
+end

data/lib/jira_client/version.rb

@@ -0,0 +1,3 @@
+module JiraClient
+  VERSION = "1.0.0"
+end

data/lib/jira_client/worklog.rb

@@ -0,0 +1,10 @@
+module JiraClient
+  class Worklog < JiraClient::Base
+    attr_reader :time_spent, :comment, :author, :update_author, :started, :time_spent_seconds
+
+    convert :author, JiraClient::User
+    convert :update_author, JiraClient::User
+    convert :started, lambda {|value| Time.parse(value)}
+    convert :time_spent_seconds, lambda {|value| value.to_i }
+  end
+end

data/spec/fixtures/admin.json

@@ -0,0 +1,17 @@
+{
+  "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+  "name": "admin",
+  "emailAddress": "admin@example.com",
+  "avatarUrls": {
+    "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+    "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+  },
+  "displayName": "admin",
+  "active": true,
+  "timeZone": "Europe/London",
+  "groups": {
+    "size": 3,
+    "items": []
+  },
+  "expand": "groups"
+}

data/spec/fixtures/basic_issue.json

@@ -0,0 +1,6 @@
+{
+  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
+  "id": "4321",
+  "self": "https://example.jira.com/rest/api/2/issue/4321",
+  "key": "PROJECT-1234"
+}

data/spec/fixtures/comment.json

@@ -0,0 +1,23 @@
+{
+    "self": "http://www.example.com/jira/rest/api/2.0/issue/10010/comment/10000",
+    "id": "10000",
+    "author": {
+        "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
+        "name": "fred",
+        "displayName": "Fred F. User",
+        "active": false
+    },
+    "body": "This is a comment",
+    "updateAuthor": {
+        "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred",
+        "name": "fred",
+        "displayName": "Fred F. User",
+        "active": false
+    },
+    "created": "2012-02-15T17:34:37.268-0600",
+    "updated": "2012-02-15T17:34:37.269-0600",
+    "visibility": {
+        "type": "role",
+        "value": "Administrators"
+    }
+}

data/spec/fixtures/comments.json

@@ -0,0 +1,30 @@
+{
+    "startAt": 0,
+    "maxResults": 1,
+    "total": 1,
+    "comments": [
+        {
+            "self": "http://www.example.com/jira/rest/api/2.0/issue/10010/comment/10000",
+            "id": "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": "2012-02-15T17:34:37.268-0600",
+            "updated": "2012-02-15T17:34:37.269-0600",
+            "visibility": {
+                "type": "role",
+                "value": "Administrators"
+            }
+        }
+    ]
+}

data/spec/fixtures/invalid_assignee.json

@@ -0,0 +1,6 @@
+{
+  "errorMessages": [],
+  "errors": {
+    "assignee": "User 'fwafawf' does not exist."
+  }
+}

data/spec/fixtures/invalid_comment.json

@@ -0,0 +1,6 @@
+{
+  "errorMessages": [],
+  "errors": {
+    "comment": "Comment body can not be empty!"
+  }
+}

data/spec/fixtures/invalid_jql.json

@@ -0,0 +1,6 @@
+{
+  "errorMessages": [
+    "The value 'DOESNT_EXIST' does not exist for the field 'project'."
+  ],
+  "errors": {}
+}

data/spec/fixtures/issue_with_comments.json

@@ -0,0 +1,33 @@
+{
+  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
+  "id": "4321",
+  "self": "https://example.jira.com/rest/api/2/issue/4321",
+  "key": "PROJECT-1234",
+  "fields": {
+    "comment": [
+      {
+        "self": "http://www.example.com/jira/rest/api/2.0/issue/10010/comment/10000",
+        "id": "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": "2012-02-15T17:34:37.268-0600",
+        "updated": "2012-02-15T17:34:37.269-0600",
+        "visibility": {
+            "type": "role",
+            "value": "Administrators"
+        }
+      }
+    ]
+  }
+}

data/spec/fixtures/issue_with_description.json

@@ -0,0 +1,10 @@
+{
+  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
+  "id": "4321",
+  "self": "https://example.jira.com/rest/api/2/issue/4321",
+  "key": "PROJECT-1235",
+  "fields": {
+    "summary": "This is an issue summary",
+    "description": "This is a description"
+  }
+}

data/spec/fixtures/issue_with_status.json

@@ -0,0 +1,15 @@
+{
+  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
+  "id": "4321",
+  "self": "https://example.jira.com/rest/api/2/issue/4321",
+  "key": "PROJECT-1236",
+  "fields": {
+    "status": {
+        "self": "https://example.jira.com/jira/rest/api/2.0/status/10000",
+        "description": "The issue is currently being worked on.",
+        "iconUrl": "https://example.jira.com/images/icons/progress.gif",
+        "name": "In Progress",
+        "id": "10000"
+    }
+  }
+}

data/spec/fixtures/issue_with_timetracking.json

@@ -0,0 +1,16 @@
+{
+  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
+  "id": "4321",
+  "self": "https://example.jira.com/rest/api/2/issue/4321",
+  "key": "PROJECT-1234",
+  "fields": {
+    "timetracking": {
+      "originalEstimate": "10m",
+      "remainingEstimate": "3m",
+      "timeSpent": "6m",
+      "originalEstimateSeconds": 600,
+      "remainingEstimateSeconds": 200,
+      "timeSpentSeconds": 400
+    }
+  }
+}

data/spec/fixtures/issue_with_worklogs.json

@@ -0,0 +1,34 @@
+{
+  "expand": "renderedFields,names,schema,transitions,operations,editmeta,changelog",
+  "id": "4321",
+  "self": "https://example.jira.com/rest/api/2/issue/4321",
+  "key": "PROJECT-1234",
+  "fields": {
+    "worklog": [
+      {
+        "self": "http://www.example.com/jira/rest/api/2.0/issue/10010/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.",
+        "started": "2012-02-15T17:34:37.937-0600",
+        "timeSpent": "3h 20m",
+        "timeSpentSeconds": 12000,
+        "id": "100028",
+        "visibility": {
+            "type": "group",
+            "value": "jira-developers"
+        }
+      }
+    ]
+  }
+}