jirarest2 0.0.5 → 0.0.6

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.0.6 / 2012-07-18
+
+* 1 minor enhancement:
+
+  * jira_create_issue.rb : Added the possibility to enter the issuefields ("-c") via STDIN or a file . Piping the data works only if URL,username and password are in the configfile (default: ~/.jiraconfig).
+
 === 0.0.5 / 2012-07-18
 
 * 1 major enhancement:

data/Manifest.txt

@@ -2,7 +2,6 @@
 GPLv3
 History.txt
 Manifest.txt
-README.md
 README.txt
 Rakefile
 bin/create_issue.rb
@@ -20,6 +19,10 @@ lib/services/issuelink.rb
 lib/services/issuelinktype.rb
 lib/services/watcher.rb
 test/data/test.config.data
+test/data/test.json
+test/data/test.nojson
+test/data/test.nojson1
+test/data/ticket.json
 test/test_connect.rb
 test/test_credentials.rb
 test/test_issue.rb

data/Rakefile

@@ -7,7 +7,7 @@ require 'hoe'
 # Hoe.plugin :cucumberfeatures
  Hoe.plugin :doofus
 # Hoe.plugin :gem_prelude_sucks
-# Hoe.plugin :gemspec
+ Hoe.plugin :gemspec
  Hoe.plugin :git
 # Hoe.plugin :inline
 # Hoe.plugin :manifest
@@ -25,6 +25,11 @@ Hoe.spec 'jirarest2' do
   extra_deps << ['json', ">= 1.6.0"]
   extra_deps << ['highline', ">= 1.1.0"]
 
+
+#  self.yard_title = 'Jirarest2'
+#  self.yard_markup = :markdown
+  self.yard_opts = ['--protected'] # any additional YARD options
+
   # self.rubyforge_name = 'jirarest2x' # if different than 'jirarest2'
 end
 

data/bin/jira_create_issue.rb

@@ -76,6 +76,10 @@ class ParseOptions
         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
@@ -253,29 +257,49 @@ def show_scheme
   exit
 end
 
-=begin
-  Prepare a new ticket. It will not be persisted yet.
-=end
-def prepare_new_ticket
-  issue = open_issue
-  valueNotAllowedRaised = false
+# Split the content from the command line parameter "-c"
+def split_content(issue)
+  fields = Hash.new
   @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
+    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
-      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
+    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

data/lib/jirarest2.rb

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

data/lib/madbitconfig.rb

@@ -18,6 +18,7 @@
 # Module to handle configuration files
 module MadbitConfig
 
+require "json"
 
 # Special exception to make the point why we threw it around
   class FileExistsException < IOError ; end
@@ -25,43 +26,63 @@ module MadbitConfig
 
 # Inspired by http://www.erickcantwell.com/2011/01/simple-configuration-file-reading-with-ruby/
 
-# reads a config-file and returns a hash
-# @param [String] configfile
-  def self.read_configfile(config_file)
-    config_file = File.expand_path(config_file)
-
-    unless File.exists?(config_file) then
-      raise IOError, "Unable to find config file \"#{config_file}\""
+  # reads a config-file and returns a hash
+  # The config file can either contain key = value pairs or JSON data
+  # JSON and simple "key = value\n" lines work 
+  # TODO make it work with "key = [value,value]\n" or even "key = value1 \n value2 \n ..."
+  # @param [String] configfile
+  # @param [Boolean] whitespace Keep whitespace characters? 
+  # @return [Hash] Hash configparameters
+  def self.read_configfile(config_file,whitespace = false)
+    if whitespace then    
+      regexp = Regexp.new(/"|\[|\]/)
+    else
+      regexp = Regexp.new(/\s+|"|\[|\]/)
     end
     
-    regexp = Regexp.new(/\s+|"|\[|\]/)
-    
     temp = Array.new
     vars = Hash.new
-    
-    IO.foreach(config_file) { |line|
-      if line.match(/^\s*#/) #  don't care about lines starting with an # (even after whitespace)
-        next
-      elsif line.match(/^\s*$/) # no text, no content
-        next
-      else
-        # Right now I don't know what to use scan for. It will escape " nice enough. But once that is excaped the regexp doesn't work any longer.
-        #        temp[0],temp[1] = line.to_s.scan(/^.*$/).to_s.split("=")
-        temp[0],temp[1] = line.to_s.split("=")
-        temp.collect! { |val|
-          val.gsub(regexp, "")
-        }
-        vars[temp[0]] = temp[1]
+    file = String.new
+
+    if config_file == "-" then
+      # caller wants STDIN
+      file = ARGF.read
+    else
+      # caller wants real file
+      config_file = File.expand_path(config_file)
+      unless File.exists?(config_file) then
+        raise IOError, "Unable to find config file \"#{config_file}\""
       end
-    }
+      file = IO.read(config_file)
+    end
+    if file =~ /^\s*{/ then
+      vars = JSON.parse(file)
+    else
+      file.each_line { |line|
+        if line.match(/^\s*#/) #  don't care about lines starting with an # (even after whitespace)
+          next
+        elsif line.match(/^\s*$/) # no text, no content
+          next
+        else
+          # Right now I don't know what to use scan for. It will escape " nice enough. But once that is excaped the regexp doesn't work any longer.
+          temp[0],temp[1] = line.to_s.scan(/^.*$/).to_s.split("=")
+          #temp[0],temp[1] = line.to_s.split("=")
+          temp.collect! { |val|
+            val.gsub(regexp, "")
+          }
+          vars[temp[0]] = temp[1]
+        end
+      }
+    end # JSON or not?
+    
     return vars
   end # read.configfile
-
-
-# write a configfile
-# @param [String] config_file Name (and path) of the config file
-# @param [Hash] configoptions Hash of "option" => "value" pairs
-# @param [Symbol] save Determines if an existing file is to be kept. :force replaces an existing file
+  
+  
+  # write a configfile
+  # @param [String] config_file Name (and path) of the config file
+  # @param [Hash] configoptions Hash of "option" => "value" pairs
+  # @param [Symbol] save Determines if an existing file is to be kept. :force replaces an existing file
   def self.write_configfile(config_file, configoptions, save = :noforce)
     config_file = File.expand_path(config_file) # Be save
     

data/test/data/test.json

@@ -0,0 +1,6 @@
+{
+  "Summary" : "This is a summary. We prefer to use it, as is",
+  "Description" : "    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor \n    incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud \n    exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute \n    irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla \n    pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia\n    deserunt mollit anim id est laborum.\n",
+   "Many Values" : ["One","Two","Three","Four"]
+
+}

data/test/data/test.nojson

@@ -0,0 +1,4 @@
+"Summary" = "This is a summary. We prefer to use it, as is"
+"Description" = "    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor \n    incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud \n    exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute \n    irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla \n    pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia\n    deserunt mollit anim id est laborum.\n"
+"Many Values" = ["One", "Two", "Three", "Four"]
+

data/test/data/test.nojson1

@@ -0,0 +1,4 @@
+Summary = This is a summary. We prefer to use it, as is
+Description =     Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor \n    incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud \n    exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute \n    irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla \n    pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia\n    deserunt mollit anim id est laborum.\n
+Many Values = [One, Two, Three, Four]
+

data/test/data/ticket.json

@@ -0,0 +1,3 @@
+{"Summary" : "A summary",
+ "Description" : "A description is always nice",
+ "Labels" : ["A", "An", "Array", "is", "what", "we", "need"]}

data/test/test_madbitconfig.rb

@@ -29,5 +29,17 @@ class TestConfig < MiniTest::Unit::TestCase
     
   end
 
+  def test_readjfile
+    testdir = File.dirname($0)
+    testfile =  testdir + "/test/data/test.json"
+    assert_equal ["One", "Two", "Three", "Four"],MadbitConfig::read_configfile(testfile)["Many Values"]
+    testfile =  testdir + "/test/data/test.nojson"
+    assert_equal " \\This is a summary. We prefer to use it, as is\\", MadbitConfig::read_configfile(testfile, true)["\\Summary\\ "] # Not really what we want but didn't know how to fix now
+    testfile =  testdir + "/test/data/test.nojson1"
+    assert_equal " One, Two, Three, Four",MadbitConfig::read_configfile(testfile, true)["Many Values "]
+    
+    # I dont' know how to run this test in a automated setup. How do we feed one of the files above to STDIN so the testscript gets the data?
+    # pp MadbitConfig::read_configfile("-") 
+  end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirarest2
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -116,7 +116,14 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.9.4
-description: ''
+description: ! "jirarest2 is yet another implementation of the JIRA(tm) REST-API[https://developer.atlassian.com/display/JIRADEV/JIRA+Remote+API+Reference]
+  .  This one for Ruby1.9.1\n\nIt is intended to be called within the shell to create
+  and verify JIRA(tm) issues fast without a browser. There was no particular need
+  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
+  *Ruby1.9.1 is needed. Ruby1.8 doesn't work!*"
 email:
 - cebit-jirarest@gunnet.de
 executables:
@@ -132,7 +139,6 @@ files:
 - GPLv3
 - History.txt
 - Manifest.txt
-- README.md
 - README.txt
 - Rakefile
 - bin/create_issue.rb
@@ -150,6 +156,10 @@ files:
 - lib/services/issuelinktype.rb
 - lib/services/watcher.rb
 - test/data/test.config.data
+- test/data/test.json
+- test/data/test.nojson
+- test/data/test.nojson1
+- test/data/ticket.json
 - test/test_connect.rb
 - test/test_credentials.rb
 - test/test_issue.rb
@@ -159,10 +169,11 @@ files:
 - test/test_result.rb
 - test/test_watcher.rb
 - .gemtest
-homepage: 
+homepage: https://github.com/cybit/jirarest2#readme
 licenses: []
 post_install_message: 
 rdoc_options:
+- --protected
 - --title
 - Jirarest2 Documentation
 - --quiet
@@ -185,7 +196,7 @@ rubyforge_project: jirarest2
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ''
+summary: jirarest2 is yet another implementation of the JIRA(tm) REST-API[https://developer.atlassian.com/display/JIRADEV/JIRA+Remote+API+Reference]
 test_files:
 - test/test_madbitconfig.rb
 - test/test_connect.rb

data/README.md

@@ -1,15 +0,0 @@
-jirarest2
-=========
-
-Another ruby gem for the REST2 interface of JIRA(tm)
-
-This is still a very early alpha state and a lot of features are not yet implemented. Classes and their work might undergo major changes. (especially "Issue")
-
-What works?
-
-  * creation of issues
-  * add watchers to the issues
-  * link new issues to issues that are already there
-  * ruby script (create-issue.rb) that enables you to do this from the command line
-
-Ruby1.9.1 is needed! Ruby1.8 will fail.