jirarest2 0.0.3 → 0.0.4

data/History.txt

@@ -1,3 +1,21 @@
+=== 0.0.4 / 2012-07-17
+
+* 1 major enhancement:
+
+  * All the methods that took Credential objects before now take Conenction objects
+
+* 2 minor enhancements:
+
+  * added heal_uri and heal_uri! methods to try to find the right url if wanted.
+  * passes Connection to all other classes now and no longer credentials.
+
+* 3 bug fixes:
+
+  * -H in create_connection works now as intended. It's even better as you can give the login URL from you browser and it will automagically exract the correct API uri in usual cases. closes #3
+  * Shebang should work now (please remember this gem depends on ruby1.9.1 to work, gem2deb is not able to reflect that.) closes #2
+  * reduced the extension of the url to "/api/rest/2" closes #1
+
+
 === 0.0.3 / 2012-07-16
 
 * 2 major enhancements:

data/Manifest.txt

@@ -6,7 +6,7 @@ README.md
 README.txt
 Rakefile
 bin/create_issue.rb
-header.copyright
+copyright
 lib/config.rb
 lib/connect.rb
 lib/credentials.rb

data/README.md

@@ -5,4 +5,11 @@ 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 is the creation of issues with easy field types and watchers.
+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.

data/README.txt

@@ -4,15 +4,23 @@
 
 == DESCRIPTION:
 
-jirarest2 is yet another implementation of the JIRA(tm) REST api ( https://developer.atlassian.com/display/JIRADEV/JIRA+Remote+API+Reference ). 
- It is intended to be called within the shell to create and verify JIRA(tm) issues fast without a browser.
- This implementation is still a for cry from others like http://rubygems.org/gems/jira-ruby which required oauth authentification. 
- Use it at your own risk most of the API features are not implemented.
+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
+
+It 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.
+
+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
+
+ *Use it at your own risk. Most of the API features are not implemented.*
+
+ *Ruby1.9.1 is needed. Ruby1.8 doesn't work!*
 
 
 == FEATURES/PROBLEMS:
 
-Still in the very first alpha stages. You can only create new issues with watchers.
+   * Still in the very first alpha stages. The classes are still pretty volatile.
+   * The script allows you to create new issues with watchers and link those to existing issues
 
 == SYNOPSIS:
 

data/Rakefile

@@ -8,7 +8,7 @@ require 'hoe'
  Hoe.plugin :doofus
 # Hoe.plugin :gem_prelude_sucks
 # Hoe.plugin :gemspec
-# Hoe.plugin :git
+ Hoe.plugin :git
 # Hoe.plugin :inline
 # Hoe.plugin :manifest
 # Hoe.plugin :newgem

data/bin/create_issue.rb

@@ -97,9 +97,15 @@ class ParseOptions
         scriptopts.username = u 
       end
       
-      opts.on("-H", "--jira-url URL", "URL to connect to jira in the browser") do |url|
-        uri = URI(URL)
-        scriptopts.url = uri.schme + "://" + uri.host + uri.port
+      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
@@ -131,8 +137,6 @@ 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!)"
@@ -153,8 +157,9 @@ def get_credentials
   @scriptopts.pass = fileconf["password"] if ( @scriptopts.pass.nil? && fileconf["password"] )
   if ( @scriptopts.url.nil? && fileconf["URL"] ) then
     @scriptopts.url = fileconf["URL"] 
-    @scriptopts.url = @scriptopts.url + "/jira/rest/api/2/"
   end
+  @scriptopts.url = @scriptopts.url + "/rest/api/2/"
+  
   if @scriptopts.pass.nil? then
     @scriptopts.pass = get_password
   end
@@ -162,14 +167,34 @@ def get_credentials
   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,credentials)
-    # issue=Issue.new(@issueopts.project,@issueopts.issue,@scriptopts.pass,@scriptopts.username)
+    issue=Issue.new(@issueopts.project,@issueopts.issue,get_connection)
   rescue Jirarest2::AuthentificationError => e
     puts "Password not accepted."
     @scriptopts.pass = get_password
@@ -231,10 +256,11 @@ end
 
 def create_new_ticket(issue)
   begin
-    result = issue.persist(get_credentials).result
+    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(get_credentials,@issueopts.watchers)
+      watcherssuccess = issue.add_watchers(connection,@issueopts.watchers)
     end
   rescue Jirarest2::RequiredFieldNotSetException => e
     puts "Required field \"#{e.to_s}\" not set."
@@ -246,7 +272,6 @@ def create_new_ticket(issue)
       puts "Watchers could not be set though."
     end
     if @issueopts.link then
-      connection = Connect.new(get_credentials)
       link = IssueLink.new(connection)
       remoteIssue,linktype  = @issueopts.link.split("=")
       linkresult = link.link(result["key"],remoteIssue,linktype)

data/{header.copyright → copyright}

@@ -1,4 +1,3 @@
-# <one line to give the program's name and a brief idea of what it does.>
 #    Copyright (C) 2012 Cyril Bitterich
 #
 #    This program is free software: you can redistribute it and/or modify

data/lib/connect.rb

@@ -78,14 +78,60 @@ class Connect
       # Result: ["CAPTCHA_CHALLENGE; login-url=http://localhost:8080/login.jsp"]
       result.get_fields("x-authentication-denied-reason")[0] =~ /.*login-url=(.*)/
       raise Jirarest2::AuthentificationCaptchaError, $1
+    when Net::HTTPNotFound
+      raise Jirarest2::NotFoundError, result
     end
     
     return Jirarest2::Result.new(result)
   end # execute
 
+=begin
+ Is the rest API really at the destination we think it is?
+=end
+  def check_uri
+    begin 
+      begin
+        ret = (execute("Get","dashboard","").code == "200")
+      rescue Jirarest2::NotFoundError
+        return false
+      end
+    end
+  end
 
+=begin
+ Try to be nice. Parse the URI and see if you can find a pattern to the problem
+=end
+  def heal_uri(url = @CONNECTURL)
+    splitURI = URI.split(url) # [Scheme,Userinfo,Host,Port,Registry,Path,Opaque,Query,Fragment]
+    splitURI[5].gsub!(/^(.*)2$/,'\12/')
+    splitURI[5].gsub!(/\/+/,'/') # get rid of duplicate /
+    splitURI[5].gsub!(/(rest\/api\/2\/)+/,'\1') # duplicate path to rest
+    splitURI[5].gsub!(/^(.*)\/login.jsp(\/rest\/api\/2\/)$/,'\1\2') # dedicated login page
+    splitURI[5].gsub!(/^(.*)\/secure\/Dashboard.jspa(\/rest\/api\/2\/)$/,'\1\2') # copied the dashboard URL (or the login Page)
+    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
+    return url
+  end
 end # class
 
+=begin
+ try to fix the connecteurl of this instance 
+=end
+public
+ def heal_uri!
+   if ! check_uri then
+     @CONNECTURL = heal_uri(@CONNECTURL)
+   end
+   if check_uri then
+     return @CONNECTURL
+   else
+     raise Jirarest2::CouldNotHealURIError, @CONNECTURL
+   end
+ end
+
 =begin
 
 

data/lib/exceptions.rb

@@ -25,6 +25,11 @@ module Jirarest2
   class AuthentificationError < StandardError ; end
   # Authentification failed and JIRA(tm) requires a login with captcha to continue
   class AuthentificationCaptchaError < StandardError ; end
+  # 404 - Results in HTML body - not JSON
+  class NotFoundError < StandardError ; end
+  # Could not heal URI
+  class CouldNotHealURIError < StandardError ; end
+  
 
   ## credentials.rb
 

data/lib/issue.rb

@@ -15,14 +15,11 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-# TODO always recreating Connection is not really DRY - Find a way to fix it.
-
 =begin
  An Issue object contains all the data of an issue
 =end
 class Issue
   
-  require "connect"
   
   # issue type of the issue 
   attr_reader :issuetype
@@ -32,11 +29,10 @@ class Issue
   attr_reader :issuekey
   
 =begin
-  New initialize method we take the project and the type we want to use and take login info that might exist just right with us
+  New initialize method we take the project and the type we want to use and a connection
   project Name of the project this issue is to live in
 =end
-  def initialize (project,type,credentials)
-    connection = Connect.new(credentials)
+  def initialize (project,type,connection)
     query = {:projectKeys => project, :issuetypeNames => type, :expand => "projects.issuetypes.fields" }
     answer = connection.execute("Get","issue/createmeta/",query)
     jhash = answer.result
@@ -229,15 +225,13 @@ TODO We are not yet able to work with "Cascading Select" fields ( "custom": "com
 =begin
  create a new ticket
 =end
-  def persist(credentials)
+  def persist(connection)
     get_requireds.each { |fieldname| 
       if @issuefields[fieldname]["value"].nil? then
         raise Jirarest2::RequiredFieldNotSetException, fieldname
       end
     }
-    connection = Connect.new(credentials)
     hash = jirahash
-    # TODO we changed the returning Value here - it's an Result object and no longer just the equivalent of Result.result
     ret = connection.execute("Post","issue/",hash) 
     if ret.code == "201" then # Ticket sucessfully created
       @issuekey = ret.result["key"]
@@ -250,9 +244,8 @@ TODO We are not yet able to work with "Cascading Select" fields ( "custom": "com
  Set the watchers for this Ticket
  watchers has to be an Array
 =end
-  def add_watchers(credentials,watchers)
+  def add_watchers(connection,watchers)
     success = false # Return whether we were successful with the watchers
-    connection = Connect.new(credentials)
     watch = Watcher.new(connection,@issuekey)
     watchers.each { |person|
       success = watch.add_watcher(person)

data/lib/jirarest2.rb

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

data/test/test_connect.rb

@@ -17,5 +17,42 @@ class TestConnect < MiniTest::Unit::TestCase
     query={"jql"=>"project = MFTP", "startAt"=>0, "maxResults"=>4 }
     assert 4, @con.execute("Post","search/",query).result["maxResults"]
   end
+
+  def test_check_uri
+    assert_equal true,@con.check_uri
+    cred = Credentials.new("http://localhost:2990/rest/api/2/","test","1234")
+    con1 = Connect.new(cred)
+    assert_equal false,con1.check_uri
+  end
+  
+  def test_heal_uri
+    cred = Credentials.new("http://localhost:2990/jira//rest/api//2//","test","1234")
+    con = Connect.new(cred)
+    assert_equal "http://localhost:2990/jira/rest/api/2/",con.heal_uri
+    assert_equal "http://localhost:2990/jira/rest/api/2/",con.heal_uri("http://localhost:2990/jira/rest/api/2/rest/api/2/")
+    assert_equal "http://localhost:2990/jira/rest/api/2/",con.heal_uri("http://localhost:2990/jira/secure/Dashboard.jspa/rest/api/2/")
+    assert_equal "http://localhost:2990/rest/api/2/",con.heal_uri("http://localhost:2990/secure/Dashboard.jspa/rest/api/2/")
+    assert_equal "http://localhost:2990/jira/rest/api/2/",con.heal_uri("http://localhost:2990/jira/login.jsp/rest/api/2/")
+    assert_equal "http://localhost:2990/rest/api/2/",con.heal_uri("http://localhost:2990/login.jsp/rest/api/2/")
+    assert_equal "http://localhost/rest/api/2/",con.heal_uri("http://localhost/login.jsp/rest/api/2")
+    assert_equal "http://localhost:2990/rest/api/2/",con.heal_uri("http://localhost:2990/login.jsp/rest/api/2")
+    assert_equal "http://localhost:2990/jira/secure/Dashboard.jspa",con.heal_uri("http://localhost:2990/jira/secure/Dashboard.jspa") # If there is no Rest-Path at this point we have a problem
+    assert_equal "http://localhost:2990/secure/Dashboard.jspa",con.heal_uri("http://localhost:2990/secure/Dashboard.jspa") # If there is no Rest-Path at this point we have a problem
+  end
+
+  def test_heal_uri!
+    ## First an URL we can fix
+    cred = Credentials.new("http://localhost:2990/jira//rest/api//2//","test","1234")
+    con = Connect.new(cred)
+    assert_equal false,con.check_uri
+    assert_equal "http://localhost:2990/jira/rest/api/2/", con.heal_uri!
+    assert_equal true,con.check_uri
+    ## And now one we cant't fix
+    cred = Credentials.new("http://localhost:2990/secure/Dashboard.jspa","test","1234")
+    con = Connect.new(cred)
+    assert_equal false,con.check_uri
+    assert_raises(Jirarest2::CouldNotHealURIError){ con.heal_uri! }
+    assert_equal false,con.check_uri
+  end
   
 end

data/test/test_issue.rb

@@ -5,18 +5,19 @@ require "jirarest2"
 class TestIssue < MiniTest::Unit::TestCase
   def setup
     @credentials = Credentials.new("http://localhost:2990/jira/rest/api/2/","test","1234")
-    @existentIssue = Issue.new("MFTP","My issue type",@credentials)
+    @connect = Connect.new(@credentials)
+    @existentIssue = Issue.new("MFTP","My issue type",@connect)
   end
 
   def testNonExistentProject
     assert_raises(Jirarest2::WrongProjectException) {
-      nonexistentProject = Issue.new("blubber","fasel",@credentials)
+      nonexistentProject = Issue.new("blubber","fasel",@connect)
     }
   end
   
   def testNonExistentIssuetype
     assert_raises(Jirarest2::WrongIssuetypeException) {
-      nonexistentIssue = Issue.new("MFTP","fasel",@credentials)
+      nonexistentIssue = Issue.new("MFTP","fasel",@connect)
     }
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirarest2
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -50,7 +50,7 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2012-07-15 00:00:00.000000000 Z
+date: 2012-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -100,12 +100,14 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.9.4
-description: ! "jirarest2 is yet another implementation of the JIRA(tm) REST api (
-  https://developer.atlassian.com/display/JIRADEV/JIRA+Remote+API+Reference ). \n
-  It is intended to be called within the shell to create and verify JIRA(tm) issues
-  fast without a browser.\n This implementation is still a for cry from others like
-  http://rubygems.org/gems/jira-ruby which required oauth authentification. \n Use
-  it at your own risk most of the API features are not implemented."
+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:
@@ -124,7 +126,7 @@ files:
 - README.txt
 - Rakefile
 - bin/create_issue.rb
-- header.copyright
+- copyright
 - lib/config.rb
 - lib/connect.rb
 - lib/credentials.rb
@@ -170,8 +172,7 @@ rubyforge_project: jirarest2
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: jirarest2 is yet another implementation of the JIRA(tm) REST api ( https://developer.atlassian.com/display/JIRADEV/JIRA+Remote+API+Reference
-  )
+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_connect.rb
 - test/test_issuelinktype.rb