jirarest2 0.0.7 → 0.0.8

data/History.txt

@@ -1,3 +1,17 @@
+=== 0.0.8 / 2012-07-25
+
+* 1 minor enhancement:
+
+  * jira_create_issue : Extended the possibilities with the -C paramter. You can now just pass on the content data or use an extended JSON to add project, issue, watchers and links. See --help-C . fixes #9 fixes #10
+
+* 1 bug fix:
+
+  * Fixed #17 and added a test to catch that behaviour in the future
+
+* 1 unknown:
+
+  * Fixed bugs with mocked tests.
+
 === 0.0.7 / 2012-07-23
 
 * 2 major enhancements:

data/README.txt

@@ -10,7 +10,7 @@ It is intended to be called within the shell to create and verify JIRA(tm) issue
 
 This implementation is still a for cry from others like http://rubygems.org/gems/jira-ruby which required oauth authentification. 
 
-The script allows you to create new issues with watchers and link those to existing issues
+The script allows you to create new issues with watchers and link those to existing issues.
 
  *Use it at your own risk. Most of the API features are not implemented.*
 

data/bin/jira_create_issue

@@ -33,6 +33,39 @@ require "uri"
 require "pp"
 
 class ParseOptions
+  
+  #print to Variants of a JSON file that we both take in as input with -C
+  def self.print_json_input
+    fullExample = '{
+   "metadata":{
+      "project":"SP",
+      "issue":"Bug",
+      "link":{ "SP-13":"blocks" },
+      "watcher":["test","admin"]
+   },
+   "content":{
+      "Summary":"Your Summary",
+      "Priority":"Trivial"
+   }
+}'
+    smallExample = '{
+   "Summary" : "Your Summary",
+   "Priority" : "Trivial"
+}'
+    division = '--------------------------------------------------------'
+    puts division
+    puts "There are two ways you can input data via -C ."
+    puts "Here are two examples to build from. "
+    puts division
+    puts "Using the command line parameters -p, -i, -l and/or -w :"
+    puts smallExample
+    puts division
+    puts "Without the need for any other command line parameters:"
+    puts fullExample
+    puts '"watcher" always needs to be an array. No matter how many entries you got.'
+    puts "You can even mix command line and -C . In this case -C will take precendence." 
+  end
+
 
   def self.required_argument(name)
     puts "Argument \"#{name}\" is mandatory."
@@ -76,7 +109,7 @@ class ParseOptions
         issueopts.content = list
       end
       
-      opts.on("-C", "--content-file FILENAME", "JSON formatted file (or \"-\" for STDIN) with the contents of -c which will be ignored (Pipes work only if URL,username AND password are in the CONFIGFILE!)") do |contentfile|
+      opts.on("-C", "--content-file FILENAME", "JSON formatted file (or \"-\" for STDIN). The file can contain just -c or -c, -i and -p. (Pipes only work if URL,username AND password are in the CONFIGFILE!)") do |contentfile|
         scriptopts.contentfile = contentfile
       end
       
@@ -85,7 +118,7 @@ class ParseOptions
       end
       
       opts.on("-l", "--link ISSUEKEY=LINKTYPE", "Key of an Issue this issue should be linked to" ) do |l|
-        issueopts.link = l
+        scriptopts.linkdestkey, scriptopts.linktype = l.split("=")
       end
       
       opts.on("-F", "--field-seperator CHAR", "A fieldseperator if one of the fields is an array (Default \"|\")") do |fs|
@@ -121,6 +154,10 @@ class ParseOptions
         scriptopts.url = url
       end
 
+      opts.on_tail("--help-C", "Example input for -C") do
+        print_json_input
+        exit
+      end
       opts.on_tail("-h", "--help", "Display this screen") do
         puts opts
         exit
@@ -134,13 +171,6 @@ class ParseOptions
     
   
     opts.parse!(args)
-
-    if issueopts.project.nil? && scriptopts.writeconf.nil? then
-      required_argument("project")      
-    end
-    if issueopts.issue.nil? && scriptopts.writeconf.nil? then
-      required_argument("issue")
-    end
     return issueopts, scriptopts
   end #parse()
 
@@ -184,7 +214,6 @@ def get_credentials
   end
   @scriptopts.url = @scriptopts.url + "/rest/api/2/"
 
-
   if @scriptopts.pass.nil? && !( @scriptopts.username.nil?)  then
     @scriptopts.pass = get_password
   end
@@ -224,6 +253,12 @@ end
 =end
 def open_issue
   begin
+    if @issueopts.project.nil?  then
+      ParseOptions::required_argument("project")      
+    end
+    if @issueopts.issue.nil? then
+      ParseOptions::required_argument("issue")
+    end
     credentials = get_credentials
     issue=Issue.new(@issueopts.project,@issueopts.issue,get_connection)
   rescue Jirarest2::AuthentificationError => e
@@ -272,16 +307,37 @@ def split_content(issue)
   return fields
 end
 
+# interpret input from file or STDIN 
+def get_jsondata_from_file
+  data = MadbitConfig::read_configfile(@scriptopts.contentfile)
+  content = Hash.new
+  if  data["metadata"] then # We have metadata and content
+    content = data["content"]
+    pp "metadata"
+    @issueopts.project = data["metadata"]["project"] if data["metadata"]["project"]
+    @issueopts.issue = data["metadata"]["issue"] if data["metadata"]["issue"]
+    pp data["metadata"]["watcher"].class
+    pp data["metadata"]["watcher"]
+    @issueopts.watchers = data["metadata"]["watcher"] if data["metadata"]["watcher"]
+    pp data["metadata"]["link"]
+    @scriptopts.linkdestkey, @scriptopts.linktype = data["metadata"]["link"].flatten if data["metadata"]["link"]
+  else # We have the simple format that carries only the content
+    content = data
+  end
+  return content
+end
+
 #  Prepare a new ticket. It will not be persisted yet.
 def prepare_new_ticket
   begin
-    issue = open_issue
     if @scriptopts.contentfile then
       #Input from file or STDIN
       puts "Your Input now"
-      fields = MadbitConfig::read_configfile(@scriptopts.contentfile)
+      fields = get_jsondata_from_file
+      issue = open_issue
     else
       #Input from the command line
+      issue = open_issue
       fields =  split_content(issue)
     end
     valueNotAllowedRaised = false
@@ -293,15 +349,14 @@ def prepare_new_ticket
   rescue Jirarest2::WrongFieldnameException => e
     no_issue("field",e)
   rescue Jirarest2::ValueNotAllowedException => e
-    puts "Value #{split[1]} not allowed for field #{split[0]}."
-    puts "Please use one of: \"" + e.message.join("\", \"") + "\""
+    puts "Value #{e} not allowed for field #{e.fieldname}."
+    puts "Please use one of: \"" + e.allowed.join("\", \"") + "\""
     valueNotAllowedRaised = true
   end
-=begin
-}
-=end
+
   if valueNotAllowedRaised then
-    raise Jirarest2::ValueNotAllowedException
+    puts "Exiting before trying to create an issue."
+    exit 1
   end
   return issue
 end
@@ -334,16 +389,19 @@ def create_new_ticket(issue)
       puts "Watchers could not be set though."
     end
     begin
-      if @issueopts.link then
+      if @scriptopts.linkdestkey then
         link = IssueLink.new(connection)
-        remoteIssue,linktype  = @issueopts.link.split("=")
-        linkresult = link.link(result["key"],remoteIssue,linktype)
+        linkresult = link.link(result["key"],@scriptopts.linkdestkey,@scriptopts.linktype)
       end
     rescue Jirarest2::ValueNotAllowedException => e
       puts "Link not created. Issuetype \"#{e.message}\" not valid."
       puts "Please use one of the these:"
       puts link.valid_issuelinktypes("\n")
       exit 1
+    rescue Jirarest2::NotFoundError => e
+      puts "Link not created. One of the issues not found. Jira says:"
+      puts e.to_s
+      exit 1
     end
     return 0
   elsif result["errors"] then

data/lib/jirarest2.rb

@@ -17,7 +17,7 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-VERSION = "0.0.7"
+VERSION = "0.0.8"
 
 require_relative "jirarest2/connect"
 require_relative "jirarest2/issue"

data/lib/jirarest2/connect.rb

@@ -77,7 +77,7 @@ class Connect
       result.get_fields("x-authentication-denied-reason")[0] =~ /.*login-url=(.*)/
       raise Jirarest2::AuthentificationCaptchaError, $1
     when Net::HTTPNotFound
-      raise Jirarest2::NotFoundError, result
+      raise Jirarest2::NotFoundError, result.body
     end
     
     return Jirarest2::Result.new(result)

data/lib/jirarest2/exceptions.rb

@@ -43,7 +43,17 @@ module Jirarest2
   # There is no field with this name for the given issue type
   class WrongFieldnameException < ArgumentError; end
   # value is not allowed for this type of fields
-  class ValueNotAllowedException < ArgumentError; end
+  class ValueNotAllowedException < ArgumentError
+    # The name of the field the value does not match to
+    attr_reader :fieldname
+    # Matching values
+    attr_reader :allowed
+    
+    def initialize(fieldname,allowed)
+      @fieldname = fieldname
+      @allowed = allowed
+    end
+  end
   # A field that is defined as "required" has not been given a value
   class RequiredFieldNotSetException < ArgumentError; end
 

data/lib/jirarest2/issue.rb

@@ -49,7 +49,7 @@ class Issue
       @project = value["key"]
       value["issuetypes"].each { |value1|
         @issuetype = value1["name"]
-        value1["fields"].delete("project") #The project key is duplicate and will make us live harder afterwards. It is marked as required but nothing happens if this key is not set.
+        value1["fields"].delete("project") #The project key is duplicate and will make our live harder afterwards. It is marked as required but nothing happens if this key is not set.
         value1["fields"].each { |key,value2|
           fields = Hash.new
           fields["id"] = key
@@ -59,7 +59,7 @@ class Issue
             name = key
           end
           # If the allowed reponses are limited we want to know them.
-          if value["allowedValues"] then
+          if value2["allowedValues"] then
             # With custom fields the identifier is "value" with the built in ones it's "name"
             identifier = "name"
             if value2["schema"]["custom"] then
@@ -160,8 +160,8 @@ class Issue
     if @issuefields[key]["allowedValues"].include?(value) 
       return true
     else
-      raise Jirarest2::ValueNotAllowedException, @issuefields[key]["allowedValues"]
-      puts "Value #{value} not allowed for field #{key}."
+#      puts "Value #{value} not allowed for field #{key}."
+      raise Jirarest2::ValueNotAllowedException.new(key, @issuefields[key]["allowedValues"]), value
     end
   end
 

data/lib/jirarest2/result.rb

@@ -44,7 +44,7 @@ module Jirarest2
       @header = httpResponse.to_hash
       @body = httpResponse.body
       #pp @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.
+      if httpResponse.instance_of?(Net::HTTPNoContent) or httpResponse.body == "" or httpResponse.body.nil? then # If there is nothing in the body it would be hard to parse it.
         @result = @body
       else
         @result = JSON.parse(@body)

data/lib/jirarest2/services/issuelink.rb

@@ -67,7 +67,7 @@ class IssueLink < Services
     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 
+        raise Jirarest2::ValueNotAllowedException.new(type,valid_issuelinktypes), type 
       else
         type = realname[0]
         if realname[1] == "inward" then # we have to change the issues as jira only knows one direction.
@@ -85,7 +85,6 @@ class IssueLink < Services
     json["inwardIssue"] = { "key" => inwardIssue }
     json["outwardIssue"] = { "key" => outwardIssue }
     json["comment"] = { "body" => comment}     if comment
-    
     return post(json)
   end
 

data/test/test_connect.rb

@@ -14,15 +14,19 @@ class TestConnect < MiniTest::Unit::TestCase
   end
 
   def test_executeGET    
-    stub_request(:get, "http://test:1234@localhost:2990/jira/rest/api/2/issue/createmeta/").with(:headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json;charset=UTF-8', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => "", :headers => {})
-    assert "projects", @con.execute("Get","issue/createmeta/","").result["expand"]
+    stub_request(:get, "http://test:1234@localhost:2990/jira/rest/api/2/issue/createmeta/").with(:headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json;charset=UTF-8', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => '{"expand":"projects"}', :headers => {})
+    assert_equal "projects", @con.execute("Get","issue/createmeta/","").result["expand"]
   end
   
   def test_executePOST
-    stub_request(:post, "http://test:1234@localhost:2990/jira/rest/api/2/search/").with(:body => "{\"jql\":\"project = MFTP\",\"startAt\":0,\"maxResults\":4}",:headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json;charset=UTF-8', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => "", :headers => {})
+    stub_request(:post, "http://test:1234@localhost:2990/jira/rest/api/2/search/").with(:body => "{\"jql\":\"project = MFTP\",\"startAt\":0,\"maxResults\":4}",:headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json;charset=UTF-8', 'User-Agent'=>'Ruby'}).to_return(:status => 200, :body => '{"expand":"schema,names","startAt":0,"maxResults":4,"total":9,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"10102","self":"http://localhost:2990/jira/rest/api/2/issue/10102","key":"MFTP-9","fields":{"summary":"AnotherissueatSunJul1516","progress":{"progress":0,"total":0}}}]}', :headers => {})
+#    WebMock.disable!
 
     query={"jql"=>"project = MFTP", "startAt"=>0, "maxResults"=>4 }
-    assert 4, @con.execute("Post","search/",query).result["maxResults"]
+    assert_equal 4, @con.execute("Post","search/",query).result["maxResults"]
+#   WebMock.enable!
+
+    pp @con.execute("Post","search/",query).result["maxResults"]
   end
 
   def test_check_uri_true

data/test/test_issue.rb

@@ -54,5 +54,15 @@ class TestIssue < MiniTest::Unit::TestCase
     assert_equal "Summary Text", issue.get_field("Summary")
   end
 
+
+  def test_persist
+    issue = @existentIssue
+    issue.set_field("Summary","Summary Text")
+    issue.set_field("Priority","Trivial")
+    stub_request(:post, "http://test:1234@localhost:2990/jira/rest/api/2/issue/").with(:body => "{\"fields\":{\"project\":{\"key\":\"MFTP\"},\"summary\":\"Summary Text\",\"priority\":{\"name\":\"Trivial\"},\"issuetype\":{\"name\":\"My issue type\"}}}",:headers => {'Accept'=>'*/*', 'Content-Type'=>'application/json;charset=UTF-8', 'User-Agent'=>'Ruby'}).to_return(:status => 201, :body => '{"id":"10608","key":"MFTP-11","self":"http://localhost:2990/jira/rest/api/2/issue/10608"}', :headers => {})
+
+    issue.persist(@connect)
+  end
+
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirarest2
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -50,7 +50,7 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -138,7 +138,7 @@ description: ! "jirarest2 is yet another implementation of the JIRA(tm) REST-API
   for perfomance at the time of writing.\n\nThis implementation is still a for cry
   from others like http://rubygems.org/gems/jira-ruby which required oauth authentification.
   \n\nThe script allows you to create new issues with watchers and link those to existing
-  issues\n\n *Use it at your own risk. Most of the API features are not implemented.*\n\n
+  issues.\n\n *Use it at your own risk. Most of the API features are not implemented.*\n\n
   *Ruby1.9.1 is needed. Ruby1.8 doesn't work!*"
 email:
 - cebit-jirarest@gunnet.de