jira4r-straightjacket 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Stuart
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= jira4r
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 James Stuart. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jira4r-straightjacket"
+    gem.summary = %Q{JIRA Soap Interface Gem}
+    gem.description = %Q{JIRA Soap Interface Gem}
+    gem.email = "tastyhat@jamesstuart.org"
+    gem.homepage = "http://github.com/tastyhat/jira4r"
+    gem.authors = ["James Stuart"]
+    gem.add_dependency "soap4r-straightjacket"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jira4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/jira4r.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jira4r-straightjacket}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Stuart"]
+  s.date = %q{2009-11-23}
+  s.description = %q{JIRA Soap Interface Gem}
+  s.email = %q{tastyhat@jamesstuart.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "jira4r.gemspec",
+     "lib/jira4r.rb",
+     "lib/jira4r/jira_tool.rb",
+     "lib/jira4r/server.rb",
+     "lib/jira4r/v2/jira_service.rb",
+     "lib/jira4r/v2/jira_service_mapping_registry.rb",
+     "lib/jira4r/v2/jira_soap_service_driver.rb",
+     "test/helper.rb",
+     "test/test_jira4r.rb",
+     "wsdl/jirasoapservice-v2.wsdl"
+  ]
+  s.homepage = %q{http://github.com/tastyhat/jira4r}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{JIRA Soap Interface Gem}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_jira4r.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<soap4r-straightjacket>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<soap4r-straightjacket>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<soap4r-straightjacket>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/jira4r/jira_tool.rb

@@ -0,0 +1,234 @@
+################################################################################
+#  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}" )
+
+        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 == "com.atlassian.jira.rpc.exception.RemoteException: Project: #{projectKey} does not exist"
+          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

data/lib/jira4r/server.rb

@@ -0,0 +1,10 @@
+module Jira4R
+  class Server < JiraTool
+    def self.connect_to(*args)
+      options = args.extract_options!
+      server = self.new("2",options[:host])
+      server.login(options[:username], options[:password]) if server
+      server
+    end
+  end
+end