jirarest2 0.0.3

data/lib/issuelink.rb

@@ -0,0 +1,74 @@
+# Watcher class
+#    Copyright (C) 2012 Cyril Bitterich
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "connect"
+=begin
+  Watchers do have their own calling
+=end
+class Watcher
+
+=begin
+  We expect to receive an existing 
+  :connection
+  :issueid
+=end
+  def initialize(connection,issueid)
+    @connection = connection
+    @uritail = "issue/#{issueid}/watchers"
+  end
+  
+  
+=begin
+ Return all the watchers of the issue
+=end
+  def get_watchers
+    ret = @connection.execute("Get",@uritail,"").result
+    watchers = Array.new
+    ret["watchers"].each { |entry|
+      watchers << entry["name"]
+    }
+    return watchers
+  end
+  
+=begin
+  Adds a new watcher for the issue
+=end
+  def add_watcher(username)
+    ret = @connection.execute("Post",@uritail,username)
+    case ret.code
+    when "204"
+      return true
+    else
+      return false
+    end
+  end
+
+=begin
+  removes one watcher from the issue
+=end
+  def remove_watcher(username)
+    query = {"username" => username}
+    ret = @connection.execute("Delete",@uritail,query)
+    case ret.code # Have to decide what to do here (Work with exceptions or with the case block)
+    when "204"
+      return true
+    else
+      false
+    end
+  end
+
+end

data/lib/jirarest2.rb

@@ -0,0 +1,28 @@
+# Jirarest2 is a gem to connect to the REST interface of JIRA(tm) . It uses Basic authentification and not oauth
+
+
+#    Copyright (C) 2012 Cyril Bitterich
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+VERSION = "0.0.3"
+
+require_relative "connect"
+require_relative "issue"
+require_relative "credentials"
+require_relative "exceptions"
+require_relative "services/watcher"
+require_relative "services"
+require_relative "services/issuelink"

data/lib/jirarest2/result.rb

@@ -0,0 +1,55 @@
+# Our own class to hide the use of Net::HTTP and uri in the results we get
+
+
+#    Copyright (C) 2012 Cyril Bitterich
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'json'
+
+module Jirarest2
+=begin
+  An object of Result contians the result of a Net::HTTP REST request that has a JSON-Body with easily accessable parameters.
+=end
+class Result
+
+  # The statuscode of the result
+  attr_reader :code
+  # header lines
+  attr_reader :header
+  # The original body of the result
+  attr_reader :body
+  # The JSON part of the body
+  attr_reader :result
+
+=begin
+ Takes an Net::HTTPResponse object and builds itself from there
+=end
+ def initialize(httpResponse)
+#   pp httpResponse
+#   pp httpResponse.body
+   @code = httpResponse.code
+   @header = httpResponse.to_hash
+   @body = httpResponse.body
+   if httpResponse.instance_of?(Net::HTTPNoContent) or httpResponse.body == "" then # If there is nothing in the body it would be hard to parse it.
+     @result = @body
+   else
+     @result = JSON.parse(@body)
+   end
+ end # initialize
+
+end # class
+
+end # module

data/lib/services.rb

@@ -0,0 +1,55 @@
+# Services super class (what the services themselves can do is mostly the same)
+#    Copyright (C) 2012 Cyril Bitterich
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "connect"
+=begin
+  Trying to keep the services together in one class so I don't have to write so much
+=end
+class Services
+
+=begin
+  We expect to receive an existing 
+  :connection
+=end
+  def initialize(connection)
+    @connection = connection
+# to be set in each subclass;
+#    @uritail = ""
+  end
+
+=begin
+ Send the GET request
+=end
+  def get(data = "")
+    return @connection.execute("Get",@uritail,data).result
+  end
+  
+=begin
+ Send the POST request
+=end
+  def post(data = "")
+    return @connection.execute("Post",@uritail,data)
+  end  
+
+=begin
+ Send the DELETE request
+=end
+  def delete(data = "")
+    return @connection.execute("Delete",@uritail,data)
+  end
+
+end #class

data/lib/services/issuelink.rb

@@ -0,0 +1,94 @@
+# IssueLink class
+#    Copyright (C) 2012 Cyril Bitterich
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "connect"
+require "services"
+require "issue"
+require "services/issuelinktype"
+require "exceptions"
+
+=begin
+  This class is responsible for the Linking of Issues
+  No real getter as of yet (I just didn't need it)
+=end
+class IssueLink < Services
+
+  def initialize(connection)
+    @uritail = "issueLink"
+    super(connection)
+  end
+
+  private
+=begin
+ return the issuekey
+=end
+  def key(issue)
+    if issue.instance_of?(Issue) then
+      return issue.issuekey 
+    else 
+      return issue
+    end
+  end
+  
+  public
+=begin
+ Links two issues
+ Right now the visibility feature for comments is not supported
+=end
+  def link_issue(thisIssue,remoteIssue,type,comment = nil)
+    inwardIssue = key(thisIssue)
+    outwardIssue = key(remoteIssue)
+    
+    # lets see if we have the right name
+    linktype = IssueLinkType.new(@connection)
+    if ! linktype.internal_name?(type) then # time to find the correct name and see if we have to exchange tickets
+      realname = linktype.name(type)
+      if realname.nil? then
+        raise Jirarest2::ValueNotAllowedException, type 
+      else
+        type = realname[0]
+        if realname[1] == "inward" then # we have to change the issues as jira only knows one direction.
+          temp = inwardIssue
+          inwardIssue = outwardIssue
+          outwardIssue = temp
+        end
+      end
+    end # if ! linktype.internal_name?
+    
+    
+    #create the hashes for JSON
+    json = Hash.new
+    json["type"] = { "name" => type }
+    json["inwardIssue"] = { "key" => inwardIssue }
+    json["outwardIssue"] = { "key" => outwardIssue }
+    json["comment"] = { "body" => comment}     if comment
+    
+    return post(json)
+  end
+
+=begin
+ Only true if successfully linked false if something happened. Elseway exactly as link_issue.
+=end
+  def link(thisIssue,remoteIssue,type,comment = nil)
+    if link_issue(thisIssue,remoteIssue,type,comment).code == "201" then
+      return true
+    else
+      return false
+    end
+  end
+
+end # class

data/lib/services/issuelinktype.rb

@@ -0,0 +1,91 @@
+# 
+#    Copyright (C) 2012 Cyril Bitterich
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "services"
+
+=begin
+  An IssueLinkType Object represents one or all IssueLinkTypes
+=end
+class IssueLinkType < Services
+
+=begin
+  We expect to receive an existing 
+  :connection
+=end
+  def initialize(connection,data = "")
+    if data == "" then
+      @uritail = "issueLinkType"
+    else
+      @uritail = "issueLinkType/#{data}"
+    end
+    super(connection)
+    @all = get
+  end
+
+private
+=begin
+  do the search for each block
+=end
+  def name_block_search(hash,uiname)
+    name = nil
+    direction = nil
+    if ( hash["inward"] == uiname) then
+      direction = "inward"
+      name = hash["name"]
+      return name, direction
+    elsif (hash["outward"] == uiname) then
+      direction = "outward"
+      name = hash["name"]
+      return name, direction
+    else 
+      return nil # Save my butt
+    end
+  end
+
+
+public
+=begin
+  Get the internal name and direction instead of the one in the UI.
+  Returns an Array with the name and the direction ("inward" or "outward") if successfull , nil if not
+=end
+  def name(uiname)
+    if @all["issueLinkTypes"].instance_of?(Array) then
+      @all["issueLinkTypes"].each{ |hash|
+        result =  name_block_search(hash,uiname)
+        return result if result # Return if we got an actual result
+      }
+    else
+      return name_block_search(@all,uiname)
+    end
+    return nil # Nothing found don't want to return @all
+  end # name
+
+=begin
+  Is the name realy the internal name we need to use?
+=end
+  def internal_name?(test)
+    if @all["issueLinkTypes"].instance_of?(Array) then
+      @all["issueLinkTypes"].each{ |hash|
+        return true if ( hash["name"] == test)
+      }
+    else
+      return ( @all["name"] == test )
+    end
+    return false # Nothing found don't want to return @all
+  end
+
+end #class

data/lib/services/watcher.rb

@@ -0,0 +1,73 @@
+# Watcher class
+#    Copyright (C) 2012 Cyril Bitterich
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require "connect"
+require "services"
+
+=begin
+  Watchers do have their own calling
+=end
+class Watcher < Services
+
+=begin
+  Set our uritail
+=end
+  def initialize(connection, issueid)
+    @uritail = "issue/#{issueid}/watchers"
+    super(connection)
+  end
+
+=begin
+ Return all the watchers of the issue
+=end
+  def get_watchers
+    ret = get
+    watchers = Array.new
+    ret["watchers"].each { |entry|
+      watchers << entry["name"]
+    }
+    return watchers
+  end
+  
+=begin
+  Adds a new watcher for the issue
+=end
+  def add_watcher(username)
+    ret = post(username)
+    case ret.code
+    when "204"
+      return true
+    else
+      return false
+    end
+  end
+
+=begin
+  removes one watcher from the issue
+=end
+  def remove_watcher(username)
+    query = {"username" => username}
+    ret = delete(query)
+    case ret.code # Have to decide what to do here (Work with exceptions or with the case block)
+    when "204"
+      return true
+    else
+      false
+    end
+  end
+
+end