jirarest2 0.0.4 → 0.0.5

data/History.txt

@@ -1,3 +1,22 @@
+=== 0.0.5 / 2012-07-18
+
+* 1 major enhancement:
+
+  * renamed create_issue.rb to jira_create_issue.rb to avoid (at least some) naming conflics
+
+* 2 minor enhancements:
+
+  * Added support to write config file closes #4
+  * moved config to madbitconfig and Module Config to MadbitConfig to get rid of conflict with the config class from ruby.
+
+* 1 bug fix:
+
+  * Fixed changed Module name in create_issue
+
+* 2 unknowns:
+
+  * Reworked documentation
+
 === 0.0.4 / 2012-07-17
 
 * 1 major enhancement:

data/Manifest.txt

@@ -6,23 +6,25 @@ README.md
 README.txt
 Rakefile
 bin/create_issue.rb
+bin/jira_create_issue.rb
 copyright
-lib/config.rb
 lib/connect.rb
 lib/credentials.rb
 lib/exceptions.rb
 lib/issue.rb
-lib/issuelink.rb
 lib/jirarest2.rb
 lib/jirarest2/result.rb
+lib/madbitconfig.rb
 lib/services.rb
 lib/services/issuelink.rb
 lib/services/issuelinktype.rb
 lib/services/watcher.rb
+test/data/test.config.data
 test/test_connect.rb
 test/test_credentials.rb
 test/test_issue.rb
 test/test_issuelink.rb
 test/test_issuelinktype.rb
+test/test_madbitconfig.rb
 test/test_result.rb
 test/test_watcher.rb

data/README.txt

@@ -24,7 +24,7 @@ The script allows you to create new issues with watchers and link those to exist
 
 == SYNOPSIS:
 
-create_issue -h
+jira_create_issue -h
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -17,6 +17,7 @@ require 'hoe'
 # Hoe.plugin :rubyforge
 # Hoe.plugin :rubygems
 # Hoe.plugin :website
+ Hoe.plugin :yard
 
 Hoe.spec 'jirarest2' do
   developer('Cyril Bitterich', 'cebit-jirarest@gunnet.de')

data/bin/create_issue.rb

@@ -17,279 +17,7 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-
-
-if RUBY_VERSION < "1.9"
-  puts "Sorry, I need ruby 1.9.1 or higher!"
-  exit1
-end
-
-require "highline/import"
-require "jirarest2"
-require "optparse"
-require "ostruct"
-require "config"
-require "uri"
-require "pp"
-
-class ParseOptions
-
-  def self.required_argument(name)
-    puts "Argument \"#{name}\" is mandatory."
-    exit 1
-  end
-
-=begin
-  parse resturn two Hashes. The first one contains the options for the issue the second one the options for the execution of the script.
-=end
-  def self.parse(args)
-    issueopts = OpenStruct.new
-    issueopts.project = nil
-    issueopts.issue = nil
-    scriptopts = OpenStruct.new
-    scriptopts.show = []
-    scriptopts.arrayseperator = "|"
-    scriptopts.configfile = "~/.jiraconfig"
-    
-    opts = OptionParser.new do |opts|
-      opts.banner = "Usage: #{__FILE__} [options]"
-      opts.separator ""
-      
-      opts.on("-p", "--project PROJECT", "Projectname") do |p|
-        issueopts.project = p
-        issueopts
-      end
-      
-      opts.on("-i", "--issue ISSUETYPE", "Issuetype") do |i|
-        issueopts.issue = i
-      end
-      
-      opts.on("-f", "--fields", "Display the fields available for this issue") do |f|
-        scriptopts.show << "fields"
-      end
-      
-      opts.on("-r", "--requireds", "Display the the mandatory content fields for this issue") do |r|
-        scriptopts.show << "requireds"
-      end
-      
-      opts.on("-c", "--content x=value,y=value,z=value", Array, "List of fields to fill") do |list|
-        issueopts.content = list
-      end
-      
-      opts.on("-w", "--watcher USERNAME,USERNAME", Array, "List of watchers") do |w|
-        issueopts.watchers = w
-      end
-      
-      opts.on("-l", "--link ISSUE=LINKTYPE", "Key of an Issue this issue should be linked to" ) do |l|
-        issueopts.link = l
-      end
-      
-      opts.on("-F", "--field-seperator CHAR", "A fieldseperator if one of the fields is an array (Default \"|\")") do |fs|
-        scriptopts.arrayseperator = fs
-      end
-
-      
-      opts.on("--config-file CONFIGFILE", "Config file containing the jira credentials. (Default: ~/.jiraconfig)") do |conffile|
-        scriptopts.configfile = conffile
-      end
-
-      opts.on("-u", "--username USERNAME", "Your Jira Username if you don't want to use the one in the master file") do |u|
-        scriptopts.username = u 
-      end
-      
-      opts.on("-H", "--jira-url URL", "URL to rest api (without \"/rest/api/2\").") do |url|
-        uri = URI(url)
-        splitURI = URI.split(url)
-        if splitURI[3] then
-          url = splitURI[0].to_s + "://" + splitURI[2].to_s + ":" + splitURI[3].to_s + splitURI[5].to_s
-        else
-          url = splitURI[0].to_s + "://" + splitURI[2].to_s + splitURI[5].to_s
-        end
-        scriptopts.url = url
-      end
-
-      opts.on_tail("-h", "--help", "Display this screen") do
-        puts opts
-        exit
-      end
-      
-      opts.on_tail("--version", "Show version") do
-        puts OptionParser::Version.join(".")
-        exit
-      end
-    end
-    
-  
-    opts.parse!(args)
-
-    if issueopts.project.nil? then
-      required_argument("project")      
-    end
-    if issueopts.issue.nil? then
-      required_argument("issue")
-    end
-    return issueopts, scriptopts
-  end #parse()
-
-
-end # class ParseOptions
-
-@issueopts, @scriptopts = ParseOptions.parse(ARGV)
-
-
-def no_issue(type,issue)
-  puts "The #{type}type you entered (\"#{issue}\")  does no exist."
-    puts "Maybe you entered the wrong type or made a typo? (Case is relevant!)"
-    exit 1
-end
-
-def get_password
-  ask("Enter your password for user \"#{@scriptopts.username}\":  ") { |q| q.echo = "*" }
-end
-
-=begin
-  Gather all the credentials and build the credentials file
-=end
-def get_credentials
-  fileconf = Config::read_configfile(@scriptopts.configfile)
-  # We don't want to set the calues from the configfile if we have them already set.
-  @scriptopts.username = fileconf["username"] if ( @scriptopts.username.nil? && fileconf["username"] )
-  @scriptopts.pass = fileconf["password"] if ( @scriptopts.pass.nil? && fileconf["password"] )
-  if ( @scriptopts.url.nil? && fileconf["URL"] ) then
-    @scriptopts.url = fileconf["URL"] 
-  end
-  @scriptopts.url = @scriptopts.url + "/rest/api/2/"
-  
-  if @scriptopts.pass.nil? then
-    @scriptopts.pass = get_password
-  end
-  
-  return Credentials.new(@scriptopts.url, @scriptopts.username, @scriptopts.pass)
-end
-
-=begin
- If there is already a conenction known returns that connection. If not or if the parameter is true it tries to create a new Connect object
-=end
-def get_connection(reconnect = false)
-  if ! @connection || reconnect then
-    begin
-      @connection = Connect.new(get_credentials)
-      @connection.heal_uri! # We want to be sure so we try to heal the connection_url if possible
-      return @connection
-    rescue Jirarest2::CouldNotHealURIError => e
-      puts "REST API not found at #{e.to_s}"
-      exit 3
-    end
-  else
-    return @connection
-  end
-end
-
-
-
-
-=begin
- create the issue on our side
-=end
-def open_issue
-  begin
-    credentials = get_credentials
-    issue=Issue.new(@issueopts.project,@issueopts.issue,get_connection)
-  rescue Jirarest2::AuthentificationError => e
-    puts "Password not accepted."
-    @scriptopts.pass = get_password
-    retry
-  rescue Jirarest2::AuthentificationCaptchaError => e
-    puts "Wrong Password too many times.\nCaptcha time at #{e.to_s} to reenable your account."
-    exit 1
-  rescue Jirarest2::WrongProjectException => e
-    no_issue("project",e)
-  rescue Jirarest2::WrongIssuetypeException => e
-    no_issue("project",e)
-  end
-  return issue
-end
-
-def show_scheme
-  issue = open_issue
-  if @scriptopts.show.include?("fields") then
-    print "Available fields: "
-    puts issue.get_fieldnames.join(", ")
-  end
-  if @scriptopts.show.include?("requireds") then
-    print "Required fields: "
-    puts issue.get_requireds.join(", ")
-  end
-  exit
-end
-
-
-def prepare_new_ticket
-  issue = open_issue
-  valueNotAllowedRaised = false
-  @issueopts.content.each { |value|
-    split = value.split("=")
-    begin
-      if issue.fieldtype(split[0]) == "array" then # If the fieldtype is an array we want to use our arrayseparator to split the fields
-        if ! split[1].nil? then 
-          split[1] = split[1].split(@scriptopts.arrayseperator)
-        end
-      end
-      issue.set_field(split[0],split[1])
-    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("\", \"") + "\""
-      valueNotAllowedRaised = true
-    end
-  }
-  if valueNotAllowedRaised then
-    raise Jirarest2::ValueNotAllowedException
-  end
-  return issue
-end
-
-def set_watchers(issue)
-  issue.set_watcher(credentials,@issueopts.watchers)
-end
-
-def create_new_ticket(issue)
-  begin
-    connection = get_connection # We need it so often in the next few lines that I prefer to get the result in a variable
-    result = issue.persist(connection).result
-    # Set the watchers
-    if @issueopts.watchers then
-      watcherssuccess = issue.add_watchers(connection,@issueopts.watchers)
-    end
-  rescue Jirarest2::RequiredFieldNotSetException => e
-    puts "Required field \"#{e.to_s}\" not set."
-    return 1
-  end
-  if result["key"] then
-    puts "Created new issue with issue id #{result["key"]} ."
-    if ! watcherssuccess then
-      puts "Watchers could not be set though."
-    end
-    if @issueopts.link then
-      link = IssueLink.new(connection)
-      remoteIssue,linktype  = @issueopts.link.split("=")
-      linkresult = link.link(result["key"],remoteIssue,linktype)
-    end
-    return 0
-  elsif result["errors"] then
-    puts "An error occured. The error message was: #{result["errors"].to_s}"
-    return 2
-  end
-end
-
-
-# The "main function"
-if @scriptopts.show != [] then
-  show_scheme
-end
-if ! @issueopts.content.nil? then # If the -c option is set. (-c and no content leads to another exception)
-  content = prepare_new_ticket
-  exit create_new_ticket(content)
-end
+puts "File has been renamed to jira_create_issue.rb"
+newfile = File.dirname($0) + "/jira_create_issue.rb"
+puts "Please use: #{newfile} #{$*.join(" ")}"
 

data/bin/jira_create_issue.rb

@@ -0,0 +1,366 @@
+#!/usr/bin/env ruby
+
+# Script to create a new issue with jira.
+#    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/>.
+#
+
+
+
+if RUBY_VERSION < "1.9"
+  puts "Sorry, I need ruby 1.9.1 or higher!"
+  exit1
+end
+
+require "highline/import"
+require "jirarest2"
+require "optparse"
+require "ostruct"
+require "madbitconfig"
+require "uri"
+require "pp"
+
+class ParseOptions
+
+  def self.required_argument(name)
+    puts "Argument \"#{name}\" is mandatory."
+    exit 1
+  end
+
+=begin
+  parse resturn two Hashes. The first one contains the options for the issue the second one the options for the execution of the script.
+=end
+  def self.parse(args)
+    issueopts = OpenStruct.new
+    issueopts.project = nil
+    issueopts.issue = nil
+    scriptopts = OpenStruct.new
+    scriptopts.show = []
+    scriptopts.arrayseperator = "|"
+    scriptopts.configfile = "~/.jiraconfig"
+    
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{__FILE__} [options]"
+      opts.separator ""
+      
+      opts.on("-p", "--project PROJECT", "Projectname") do |p|
+        issueopts.project = p
+        issueopts
+      end
+      
+      opts.on("-i", "--issue ISSUETYPE", "Issuetype") do |i|
+        issueopts.issue = i
+      end
+      
+      opts.on("-f", "--fields", "Display the fields available for this issue") do |f|
+        scriptopts.show << "fields"
+      end
+      
+      opts.on("-r", "--requireds", "Display the the mandatory content fields for this issue") do |r|
+        scriptopts.show << "requireds"
+      end
+      
+      opts.on("-c", "--content x=value,y=value,z=value", Array, "List of fields to fill") do |list|
+        issueopts.content = list
+      end
+      
+      opts.on("-w", "--watcher USERNAME,USERNAME", Array, "List of watchers") do |w|
+        issueopts.watchers = w
+      end
+      
+      opts.on("-l", "--link ISSUE=LINKTYPE", "Key of an Issue this issue should be linked to" ) do |l|
+        issueopts.link = l
+      end
+      
+      opts.on("-F", "--field-seperator CHAR", "A fieldseperator if one of the fields is an array (Default \"|\")") do |fs|
+        scriptopts.arrayseperator = fs
+      end
+
+      
+      opts.on("--config-file CONFIGFILE", "Config file containing the jira credentials. (Default: ~/.jiraconfig)") do |conffile|
+        scriptopts.configfile = conffile
+      end
+      
+      opts.on("--write-config-file", "Writes the configfile with the data given if it does not alredy exist.") do |wc|
+        scriptopts.writeconf = :write
+      end
+
+      opts.on("--force-write-config-file", "Writes the configfile with the data given even if it does alredy exist.") do |wc|
+        scriptopts.writeconf = :forcewrite
+      end
+      
+
+      opts.on("-u", "--username USERNAME", "Your Jira Username if you don't want to use the one in the master file") do |u|
+        scriptopts.username = u 
+      end
+      
+      opts.on("-H", "--jira-url URL", "URL to rest api (without \"/rest/api/2\").") do |url|
+        uri = URI(url)
+        splitURI = URI.split(url)
+        if splitURI[3] then
+          url = splitURI[0].to_s + "://" + splitURI[2].to_s + ":" + splitURI[3].to_s + splitURI[5].to_s
+        else
+          url = splitURI[0].to_s + "://" + splitURI[2].to_s + splitURI[5].to_s
+        end
+        scriptopts.url = url
+      end
+
+      opts.on_tail("-h", "--help", "Display this screen") do
+        puts opts
+        exit
+      end
+      
+      opts.on_tail("--version", "Show version") do
+        puts OptionParser::Version.join(".")
+        exit
+      end
+    end
+    
+  
+    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()
+
+
+end # class ParseOptions
+
+@issueopts, @scriptopts = ParseOptions.parse(ARGV)
+
+
+def no_issue(type,issue)
+  puts "The #{type}type you entered (\"#{issue}\")  does no exist."
+    puts "Maybe you entered the wrong type or made a typo? (Case is relevant!)"
+    exit 1
+end
+
+=begin
+  Get the password from an interactive shell
+=end
+def get_password
+  ask("Enter your password for user \"#{@scriptopts.username}\":  ") { |q| 
+    q.echo = "*" 
+  }
+end
+
+=begin
+  Gather all the credentials and build the credentials file
+=end
+def get_credentials
+  filefail = false
+  begin
+    fileconf = MadbitConfig::read_configfile(@scriptopts.configfile)
+    # We don't want to set the Values from the configfile if we have them already set.
+    @scriptopts.username = fileconf["username"] if ( @scriptopts.username.nil? && fileconf["username"] )
+    @scriptopts.pass = fileconf["password"] if ( @scriptopts.pass.nil? && fileconf["password"] )
+    if ( @scriptopts.url.nil? && fileconf["URL"] ) then
+      @scriptopts.url = fileconf["URL"] 
+    end
+  rescue IOError => e
+    puts e
+    filefail = false
+  end
+  @scriptopts.url = @scriptopts.url + "/rest/api/2/"
+
+
+  if @scriptopts.pass.nil? && !( @scriptopts.username.nil?)  then
+    @scriptopts.pass = get_password
+  end
+
+  missing = Array.new
+  missing << "URL"  if @scriptopts.url.nil?
+  missing << "username" if  @scriptopts.username.nil?
+#  missing << "password" if @scriptopts.pass.nil?
+  if  missing != [] then
+    puts "Missing essential parameter(s) #{missing.join(",")}. Exiting..."
+    exit 1
+  else
+    return Credentials.new(@scriptopts.url, @scriptopts.username, @scriptopts.pass)
+  end
+end
+
+=begin
+ If there is already a conenction known returns that connection. If not or if the parameter is true it tries to create a new Connect object
+=end
+def get_connection(reconnect = false)
+  if ! @connection || reconnect then
+    begin
+      @connection = Connect.new(get_credentials)
+      @connection.heal_uri! # We want to be sure so we try to heal the connection_url if possible
+      return @connection
+    rescue Jirarest2::CouldNotHealURIError => e
+      puts "REST API not found at #{e.to_s}"
+      exit 3
+    end
+  else
+    return @connection
+  end
+end
+
+=begin
+ create the issue on our side
+=end
+def open_issue
+  begin
+    credentials = get_credentials
+    issue=Issue.new(@issueopts.project,@issueopts.issue,get_connection)
+  rescue Jirarest2::AuthentificationError => e
+    puts "Password not accepted."
+    @scriptopts.pass = get_password
+    retry
+  rescue Jirarest2::AuthentificationCaptchaError => e
+    puts "Wrong Password too many times.\nCaptcha time at #{e.to_s} to reenable your account."
+    exit 1
+  rescue Jirarest2::WrongProjectException => e
+    no_issue("project",e)
+  rescue Jirarest2::WrongIssuetypeException => e
+    no_issue("project",e)
+  end
+  return issue
+end
+
+=begin
+ Show available fields and required fields
+=end
+def show_scheme
+  issue = open_issue
+  if @scriptopts.show.include?("fields") then
+    print "Available fields: "
+    puts issue.get_fieldnames.join(", ")
+  end
+  if @scriptopts.show.include?("requireds") then
+    print "Required fields: "
+    puts issue.get_requireds.join(", ")
+  end
+  exit
+end
+
+=begin
+  Prepare a new ticket. It will not be persisted yet.
+=end
+def prepare_new_ticket
+  issue = open_issue
+  valueNotAllowedRaised = false
+  @issueopts.content.each { |value|
+    split = value.split("=")
+    begin
+      if issue.fieldtype(split[0]) == "array" then # If the fieldtype is an array we want to use our arrayseparator to split the fields
+        if ! split[1].nil? then 
+          split[1] = split[1].split(@scriptopts.arrayseperator)
+        end
+      end
+      issue.set_field(split[0],split[1])
+    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("\", \"") + "\""
+      valueNotAllowedRaised = true
+    end
+  }
+  if valueNotAllowedRaised then
+    raise Jirarest2::ValueNotAllowedException
+  end
+  return issue
+end
+
+=begin
+  a little bit to fine - could be put into the method below
+=end
+def set_watchers(issue)
+  issue.set_watcher(credentials,@issueopts.watchers)
+end
+
+=begin
+  do all the work to actually create a new ticket (persist, watchers, links) 
+=end
+def create_new_ticket(issue)
+  begin
+    connection = get_connection # We need it so often in the next few lines that I prefer to get the result in a variable
+    result = issue.persist(connection).result
+    # Set the watchers
+    if @issueopts.watchers then
+      watcherssuccess = issue.add_watchers(connection,@issueopts.watchers)
+    end
+  rescue Jirarest2::RequiredFieldNotSetException => e
+    puts "Required field \"#{e.to_s}\" not set."
+    return 1
+  end
+  if result["key"] then
+    puts "Created new issue with issue id #{result["key"]} ."
+    if ! watcherssuccess && @issueopts.watchers then
+      puts "Watchers could not be set though."
+    end
+    if @issueopts.link then
+      link = IssueLink.new(connection)
+      remoteIssue,linktype  = @issueopts.link.split("=")
+      linkresult = link.link(result["key"],remoteIssue,linktype)
+    end
+    return 0
+  elsif result["errors"] then
+    puts "An error occured. The error message was: #{result["errors"].to_s}"
+    return 2
+  end
+end
+
+=begin
+ called to write the config file
+=end
+def write_configfile
+  text = Hash.new
+  if @scriptopts.url.nil? then
+    text["#URL"] = "https://host.domain.com:port/path/"
+  else
+    text["URL"] = "#{@scriptopts.url}"
+  end
+  if @scriptopts.username.nil? then
+    text["#username"] = "USERNAME"
+  else
+    text["username"] = "#{@scriptopts.username}"
+  end
+  text["#password"] = "Your!PassW0rd"
+  begin
+    if @scriptopts.writeconf == :forcewrite then
+      MadbitConfig::write_configfile(@scriptopts.configfile,text,:force)
+    else
+      MadbitConfig::write_configfile(@scriptopts.configfile,text)
+    end
+    puts "Configfile written to #{@scriptopts.configfile}. Exiting."
+    exit 0
+  rescue MadbitConfig::FileExistsException => e
+    puts "Configfile #{e} already exists. Use \"--force-write-config-file\" to replace."
+    exit 1
+  end
+end
+
+
+# The "main function"
+if @scriptopts.show != [] then
+  show_scheme
+end
+if @scriptopts.writeconf then
+  write_configfile
+end
+if ! @issueopts.content.nil? then # If the -c option is set. (-c and no content leads to another exception)
+  content = prepare_new_ticket
+  exit create_new_ticket(content)
+end
+