jira4r-jh 0.4.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rspec", "< 2.0.0"
+end
+
+gem "soap4r"

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    httpclient (2.1.6)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (1.3.0)
+    soap4r (1.5.8)
+      httpclient (>= 2.1.1)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rspec (< 2.0.0)
+  soap4r

data/LICENSE

@@ -0,0 +1,14 @@
+
+   Copyright 2006-2009 Codehaus Foundation
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,3 @@
+Codehaus JIRA4R
+
+Copyright 2006-2009 The Codehaus Foundation

data/README.textile

@@ -0,0 +1,3 @@
+h1. jira4r
+
+The current gem version of jira4r (0.3.0) is ancient. There is a more up to date version here http://xircles.rubyhaus.org/projects/jira4r so I have just cloned it so I can create my own gem of the source (jira4r-jh). Once a more up to date version of jira4r get's released I will remove this one.

data/README.txt

@@ -0,0 +1,3 @@
+h1. jira4r
+
+The current gem version of jira4r (0.3.0) is ancient. There is a more up to date version here http://xircles.rubyhaus.org/projects/jira4r so I have just cloned it so I can create my own gem of the source (jira4r-jh). Once a more up to date version of jira4r get's released I will remove this one.

data/Rakefile

@@ -0,0 +1,187 @@
+require 'net/http'
+require 'fileutils'
+require 'rake/clean'
+require 'logger'
+
+begin
+  require 'rubygems'
+  require 'bundler'
+  require 'rake/gempackagetask'
+rescue Exception
+  nil
+end
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "jira4r-jh"
+  gem.homepage = "http://xircles.rubyhaus.org/projects/jira4r"
+  gem.license = "Apache"
+  gem.summary = %Q{Clone of latest source from http://xircles.rubyhaus.org/projects/jira4r }
+  gem.description = %Q{the current version of jira4r is quite old. there is a newer version but there isn't a new gem for it so I am just releasing it}
+  gem.email = "jamiehollingworth@gmail.com"
+  gem.authors = ["James Stuart", "James Hollingworth"]
+
+  gem.add_runtime_dependency 'soap4r'
+  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_development_dependency 'jeweler'
+  gem.add_development_dependency 'bundler'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+
+gem 'soap4r'
+
+require 'wsdl/soap/wsdl2ruby'
+
+logger = Logger.new(STDERR)
+logger.level = Logger::INFO
+
+
+desc "gets the wsdl and generates the classes"
+task :default => [:generate]
+
+
+desc "gets the wsdl files for JIRA services"
+task :getwsdl do
+  versions().each { |version| 
+    save(getWsdlFileName(version), get_file("jira.codehaus.org", "/rpc/soap/jirasoapservice-v#{version}?wsdl"))
+  }
+end
+
+task :clean do
+  def unl(file)
+    File.unlink(file) if File.exist?(file)
+  end
+  unl("wsdl/jirasoapservice-v2.wsdl")
+  unl("lib/jira4r/v2/jiraService.rb")
+  unl("lib/jira4r/v2/jiraServiceDriver.rb")
+  unl("lib/jira4r/v2/jiraServiceMappingRegistry.rb")
+end
+
+desc "generate the wsdl"
+task :generate do
+  versions().each { |version|
+    wsdl = getWsdlFileName(version)
+    basedir = "lib/jira4r/v#{version}"
+    mkdir_p basedir
+
+    if not File.exist?(wsdl)
+      raise "WSDL does not exist: #{wsdl}"
+    end
+    wsdl_url = "file://#{File.expand_path(wsdl)}"
+
+    # Create the server
+    worker = WSDL::SOAP::WSDL2Ruby.new
+    worker.logger = logger
+    worker.location = wsdl_url
+    worker.basedir = basedir
+    worker.opt['force'] = true
+    worker.opt['classdef'] = "jiraService"
+    worker.opt['module_path'] ="Jira4R::V#{version}"
+    
+    worker.opt['mapping_registry'] = true
+    #worker.run
+    
+    #Create the driver
+    #worker = WSDL::SOAP::WSDL2Ruby.new
+    #worker.logger = logger
+    #worker.location = wsdl_url
+    #worker.basedir = basedir
+    #worker.opt['force'] = true
+    #worker.opt['module_path'] = "Jira4R::V#{version}"
+
+    worker.opt['driver'] = "JiraSoapService"
+    worker.run
+  }
+end
+
+def versions 
+ [ 2 ]
+end
+
+def get_file(host, path)
+    puts "getting http://#{host}#{path}"
+    http = Net::HTTP.new(host)
+    http.start { |w| w.get2(path).body }
+end
+
+def getWsdlFileName(vName)
+  "wsdl/jirasoapservice-v#{vName}.wsdl"
+end
+
+
+# Saves this document to the specified @var path.
+# doesn't create the file if contains markup for 404 page
+def save( path, content )
+  File::open(path, 'w') { | f | 
+    f.write( content ) 
+  }
+end
+
+def fix_soap_files(version)
+  fix_require("lib/jira4r/v#{version}/jiraServiceMappingRegistry.rb")
+  fix_require("lib/jira4r/v#{version}/JiraSoapServiceDriver.rb")
+end
+
+def fix_require(filename)
+  content = ""
+  File.open(filename) { |io| 
+    content = io.read()
+    
+    content = fix_content(content, 'jiraService')
+    content = fix_content(content, 'jiraServiceMappingRegistry')
+  }
+  
+  File.open(filename, "w") { |io| 
+    io.write(content)
+  }
+end
+
+def fix_content(content, name)
+  return content.gsub("require '#{name}.rb'", "require File.dirname(__FILE__) + '/#{name}.rb'")
+end
+
+SPEC_DIR = File.join(File.dirname(__FILE__), 'spec')
+FIXTURE_DIR = File.join(SPEC_DIR, 'fixtures')
+SPECS = "#{SPEC_DIR}/*_spec.rb"
+
+begin
+  require 'spec/rake/spectask'
+  
+  begin
+    require 'rcov/rcovtask'
+
+    Spec::Rake::SpecTask.new do |t|
+      t.libs << SPEC_DIR
+      t.pattern = SPECS
+      t.rcov = true
+      t.rcov_dir = "#{SPEC_DIR}/coverage"
+      t.verbose = true
+    end
+  
+    desc "Generate and open coverage reports"
+    task :rcov do
+      system "open #{SPEC_DIR}/coverage/index.html"
+    end
+    task :rcov => :spec
+  rescue LoadError
+    ### Enabling these warnings makes every run of rake whiny unless you have these gems.
+    # warn ">>> You don't seem to have the rcov gem installed; not adding coverage tasks"
+    Spec::Rake::SpecTask.new do |t|
+      t.libs << SPEC_DIR
+      t.pattern = SPECS
+      t.verbose = true
+    end
+  end
+rescue LoadError
+  # warn ">>> You don't seem to have the rspec gem installed; not adding rspec tasks"
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/jira4r-jh.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jira4r-jh}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Stuart", "James Hollingworth"]
+  s.date = %q{2011-01-01}
+  s.description = %q{the current version of jira4r is quite old. there is a newer version but there isn't a new gem for it so I am just releasing it}
+  s.email = %q{jamiehollingworth@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.textile",
+    "README.txt"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "NOTICE",
+    "README.textile",
+    "README.txt",
+    "Rakefile",
+    "VERSION",
+    "jira4r-jh.gemspec",
+    "lib/jira4r/.DS_Store",
+    "lib/jira4r/jira4r.rb",
+    "lib/jira4r/jira_tool.rb",
+    "lib/jira4r/v2/.DS_Store",
+    "lib/jira4r/v2/JiraSoapServiceDriver.rb",
+    "lib/jira4r/v2/jiraService.rb",
+    "lib/jira4r/v2/jiraServiceMappingRegistry.rb",
+    "lib/jiraService.rb",
+    "lib/jiraServiceMappingRegistry.rb",
+    "spec/.gitignore",
+    "spec/jira4r_spec.rb",
+    "spec/spec_helper.rb",
+    "wsdl/jirasoapservice-v2.wsdl"
+  ]
+  s.homepage = %q{http://xircles.rubyhaus.org/projects/jira4r}
+  s.licenses = ["Apache"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Clone of latest source from http://xircles.rubyhaus.org/projects/jira4r}
+  s.test_files = [
+    "spec/jira4r_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<soap4r>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rspec>, ["< 2.0.0"])
+      s.add_runtime_dependency(%q<soap4r>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["> 1.2.3"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+    else
+      s.add_dependency(%q<soap4r>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rspec>, ["< 2.0.0"])
+      s.add_dependency(%q<soap4r>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["> 1.2.3"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<soap4r>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rspec>, ["< 2.0.0"])
+    s.add_dependency(%q<soap4r>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["> 1.2.3"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+  end
+end
+

data/lib/jira4r/jira4r.rb

@@ -0,0 +1,19 @@
+################################################################################
+#  Copyright 2007 Codehaus Foundation                                          #
+#                                                                              #
+#  Licensed under the Apache License, Version 2.0 (the "License");             #
+#  you may not use this file except in compliance with the License.            #
+#  You may obtain a copy of the License at                                     #
+#                                                                              #
+#     http://www.apache.org/licenses/LICENSE-2.0                               #
+#                                                                              #
+#  Unless required by applicable law or agreed to in writing, software         #
+#  distributed under the License is distributed on an "AS IS" BASIS,           #
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.    #
+#  See the License for the specific language governing permissions and         #
+#  limitations under the License.                                              #
+################################################################################
+
+#Oh how I hate thee...
+$: << File.dirname(__FILE__) + '/..'
+require 'jira4r/jira_tool.rb'

data/lib/jira4r/jira_tool.rb

@@ -0,0 +1,239 @@
+################################################################################
+#  Copyright 2006-2009 Codehaus Foundation
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+################################################################################
+require 'logger'
+
+#It is the responsibility of the caller to ensure SOAP4R is installed and working correctly
+#require 'rubygems'
+#gem 'soap4r'
+
+module Jira4R
+  
+  class JiraTool
+    attr_accessor :enhanced
+    
+    # Create a new JiraTool
+    # 
+    # where:
+    # version ... the version of the SOAP API you wish to use - currently supported versions  [ 2 ]
+    # base_url ... the base URL of the JIRA instance - eg. http://confluence.atlassian.com
+    def initialize(version, base_url)
+      @version = version
+      @base_url = base_url  
+      @logger = Logger.new(STDERR)
+      @endpoint_url = "#{@base_url}/rpc/soap/jirasoapservice-v#{version}"
+    end
+    
+    #Assign a new logger to the tool. By default a STDERR logger is used.
+    def logger=(logger)
+      @logger = logger
+    end
+
+    def http_auth(http_username, http_password, http_realm)
+      @http_username = http_username
+      @http_password = http_password
+      @http_realm = http_realm
+    end
+    
+    #Retrieve the driver, creating as required.
+    def driver()
+      if not @driver
+        @logger.info( "Connecting driver to #{@endpoint_url}" )
+
+        require "jira4r/v#{@version}/jiraService.rb"
+        require "jira4r/v#{@version}/JiraSoapServiceDriver.rb"
+        require "jira4r/v#{@version}/jiraServiceMappingRegistry.rb"
+        
+        service_classname = "Jira4R::V#{@version}::JiraSoapService"
+        puts "Service: #{service_classname}"
+        service = eval(service_classname)
+        @driver = service.send(:new, @endpoint_url)
+
+        if not ( @http_realm.nil? or @http_username.nil? or @http_password.nil? )
+          @driver.options["protocol.http.basic_auth"] << [ @http_realm, @http_username, @http_password ]
+        end
+      end
+      @driver
+    end
+    
+    #Assign a wiredump file prefix to the driver.
+    def wiredump_file_base=(base)
+      driver().wiredump_file_base = base
+    end
+    
+  
+    #Login to the JIRA instance, storing the token for later calls. 
+    # 
+    #This is typically the first call that is made on the JiraTool.
+    def login(username, password)
+      @token = driver().login(username, password)
+    end
+
+    #Clients should avoid using the authentication token directly.    
+    def token()
+      @token
+    end
+    
+    #Call a method on the driver, adding in the authentication token previously determined using login()
+    def call_driver(method_name, *args)
+      @logger.debug("Finding method #{method_name}")
+      method = driver().method(method_name)     
+      
+      if args.length > 0
+        method.call(@token, *args)     
+      else
+        method.call(@token)
+      end
+    end
+    
+    #Retrieve a project without the associated PermissionScheme.
+    #This will be significantly faster for larger Jira installations.
+    #See: JRA-10660
+    def getProjectNoScheme(key)
+      puts "getProjectNoScheme is deprecated. Please call getProjectNoSchemes."
+      getProjectNoSchemes(key)
+    end
+    
+    def getProjectNoSchemes(key)
+      self.getProjectsNoSchemes().find { |project| project.key == key }
+    end
+    
+    def getProject(key)
+      #Jira > 3.10 has been patched to support this method directly as getProjectByKey
+      puts "Using deprecated JIRA4R API call getProject(key); replace with getProjectByKey(key)"
+      return getProjectByKey(key)
+    end
+    
+    def getProjectByKey( projectKey )
+      begin
+        return call_driver( "getProjectByKey", projectKey )
+      rescue SOAP::FaultError => soap_error
+        #XXX surely there is a better way to detect this kind of condition in the JIRA server
+        if (soap_error.faultcode.to_s == "soapenv:Server.userException") and
+           (soap_error.faultstring.to_s =~ /No project could be found with key '#{projectKey}'/)
+          return nil
+        else
+          raise soap_error
+        end
+      end
+    end
+    
+    def getGroup( groupName )
+      begin
+        return call_driver( "getGroup", groupName )
+      rescue SOAP::FaultError => soap_error
+        #XXX surely there is a better way to detect this kind of condition in the JIRA server
+        if soap_error.faultcode.to_s == "soapenv:Server.userException" and soap_error.faultstring.to_s == "com.atlassian.jira.rpc.exception.RemoteValidationException: no group found for that groupName: #{groupName}"
+          return nil
+        else
+          raise soap_error
+        end
+      end
+    end
+    
+    def getProjectRoleByName( projectRoleName )
+      getProjectRoles.each{ |projectRole|
+        return projectRole if projectRole.name == projectRoleName
+      }
+    end
+    
+    def getPermissionScheme( permissionSchemeName )
+      self.getPermissionSchemes().each { |permission_scheme| 
+        return permission_scheme if permission_scheme.name == permissionSchemeName
+      }
+      return nil
+    end
+    
+    def getNotificationScheme( notificationSchemeName )
+      self.getNotificationSchemes().each { |notification_scheme| 
+        return notification_scheme if notification_scheme.name == notificationSchemeName
+      }
+      return nil
+    end
+    
+    def getPermission( permissionName )
+      if not @permissions
+        @permissions = self.getAllPermissions()
+      end
+      
+      @permissions.each { |permission|
+        return permission if permission.name.downcase == permissionName.downcase
+      }
+      
+      @logger.warn("No permission #{permissionName} found")
+      return nil
+    end
+    
+    def findPermission(allowedPermissions, permissionName)
+      allowedPermissions.each { |allowedPermission|
+         #puts "Checking #{allowedPermission.name} against #{permissionName} "
+         return allowedPermission if allowedPermission.name == permissionName
+      }
+      return nil    
+    end
+    
+    def findEntityInPermissionMapping(permissionMapping, entityName)
+      permissionMapping.remoteEntities.each { |entity|
+        return entity if entity.name == entityName
+      }
+      return nil
+    end
+    
+    #Removes entity
+    def setPermissions( permissionScheme, allowedPermissions, entity)
+      allowedPermissions = [ allowedPermissions ].flatten.compact
+      #Remove permissions that are no longer allowed
+      permissionScheme.permissionMappings.each { |mapping|
+        next unless findEntityInPermissionMapping(mapping, entity.name)
+      
+        allowedPermission = findPermission(allowedPermissions, mapping.permission.name)
+        if allowedPermission
+          puts "Already has #{allowedPermission.name} in #{permissionScheme.name} for #{entity.name}"
+          allowedPermissions.delete(allowedPermission)
+        next
+      end
+
+      puts "Deleting #{mapping.permission.name} from #{permissionScheme.name} for #{entity.name}"
+        deletePermissionFrom( permissionScheme, mapping.permission, entity)
+      }
+      
+      puts allowedPermissions.inspect
+      allowedPermissions.each { |allowedPermission|
+        puts "Granting #{allowedPermission.name} to #{permissionScheme.name} for #{entity.name}"
+        addPermissionTo(permissionScheme, allowedPermission, entity) 
+      }   
+    end
+
+private
+    def fix_args(args)
+      args.collect { |arg|
+        if arg == nil
+          SOAP::SOAPNil.new
+        else
+          arg
+        end
+      }
+    end
+    
+    def method_missing(method_name, *args)
+      args = fix_args(args)
+      call_driver(method_name, *args)
+    end
+    
+    
+  
+  end  
+
+end