jirarest2 0.0.6 → 0.0.7

data/bin/jira_create_issue.rb

@@ -17,374 +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 "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("-C", "--content-file FILENAME", "JSON formatted file (or \"-\" for STDIN) with the contents of -c (Pipes work only if URL,username AND password are in the CONFIGFILE!)") do |contentfile|
-        scriptopts.contentfile = contentfile
-      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
-
-# Split the content from the command line parameter "-c"
-def split_content(issue)
-  fields = Hash.new
-  @issueopts.content.each { |value|
-    split = value.split("=")
-    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
-    fields[split[0]] = split[1]
-  }
-  return fields
-end
-
-#  Prepare a new ticket. It will not be persisted yet.
-def prepare_new_ticket
-  issue = open_issue
-  begin
-    if @scriptopts.contentfile then
-      #Input from file or STDIN
-      puts "Your Input now"
-      fields = MadbitConfig::read_configfile(@scriptopts.contentfile)
-    else
-      #Input from the command line
-      fields =  split_content(issue)
-    end
-    valueNotAllowedRaised = false
-    fields.each { |name,value|
-      issue.set_field(name,value) 
-    }
-  rescue JSON::ParserError => e
-    raise JSON::ParserError, e # Maybe I want to make this nice sometimes
-  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
-=begin
-}
-=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
+puts "File has been renamed to jira_create_issue"
+newfile = File.dirname($0) + "/jira_create_issue"
+puts "Please use: #{newfile} #{$*.join(" ")}"
 

data/lib/jirarest2.rb

@@ -17,12 +17,12 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-VERSION = "0.0.6"
+VERSION = "0.0.7"
 
-require_relative "connect"
-require_relative "issue"
-require_relative "credentials"
-require_relative "exceptions"
-require_relative "services/watcher"
-require_relative "services"
-require_relative "services/issuelink"
+require_relative "jirarest2/connect"
+require_relative "jirarest2/issue"
+require_relative "jirarest2/credentials"
+require_relative "jirarest2/exceptions"
+require_relative "jirarest2/services/watcher"
+require_relative "jirarest2/services"
+require_relative "jirarest2/services/issuelink"

data/lib/{connect.rb → jirarest2/connect.rb}

@@ -17,7 +17,7 @@
 
 
 require 'net/http'
-require 'exceptions'
+require 'jirarest2/exceptions'
 require 'jirarest2/result'
 require "pp"
 

data/lib/{issue.rb → jirarest2/issue.rb}

@@ -47,14 +47,14 @@ class Issue
     @issuetype = ""
     jhash["projects"].each { |value|
       @project = value["key"]
-      value["issuetypes"].each { |value|
-        @issuetype = value["name"]
-        value["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.
-        value["fields"].each { |key,value|
+      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"].each { |key,value2|
           fields = Hash.new
           fields["id"] = key
-          if value["name"] then
-            name = value["name"]
+          if value2["name"] then
+            name = value2["name"]
           else
             name = key
           end
@@ -62,22 +62,22 @@ class Issue
           if value["allowedValues"] then
             # With custom fields the identifier is "value" with the built in ones it's "name"
             identifier = "name"
-            if value["schema"]["custom"] then
+            if value2["schema"]["custom"] then
               identifier = "value"
             end
             allowedValues = Array.new
-            value["allowedValues"].each { |value|
-              allowedValues << value[identifier]
-            }
+            value2["allowedValues"].each { |value3|
+              allowedValues << value3[identifier]
+            } # value3
             fields["allowedValuesIdentifier"] = identifier
             fields["allowedValues"] = allowedValues
           end
-          fields["required"] = value["required"] 
-          fields["type"] = value["schema"]["type"]
+          fields["required"] = value2["required"] 
+          fields["type"] = value2["schema"]["type"]
           @issuefields[name] = fields if name != "Issue Type" # "Issue Type" is not really a required field as we have to assign it at another place anyway
-        }
-      }
-    }
+        } # value1
+      } # value
+    } # jhash
   end
   
   # @param [String] field Name of the field