better_jira 0.0.1

data/lib/better_jira/core_ext.rb

@@ -0,0 +1,15 @@
+class Hash
+  def symbolize_keys!
+    replace(inject({}) { |h,(k,v)| h[k.to_sym] = v; h })
+  end
+  
+  def require_keys!(*keys)
+    missing = []
+    
+    keys.each do |key|
+      missing << key unless self.has_key? key
+    end
+
+    raise "Required keys: #{missing.join(", ")}" unless missing.empty?
+  end
+end

data/lib/better_jira/exceptions.rb

@@ -0,0 +1,22 @@
+module BetterJira
+  module Exceptions
+    def self.wrap_soap
+      begin
+        yield
+      rescue SOAP::FaultError
+        case $!.faultstring.data
+        when "com.atlassian.jira.rpc.exception.RemotePermissionException: This issue does not exist or you don't have permission to view it."
+          raise NoSuchIssueException, "This issue does not exist or you don't have permission to view it."
+        end
+      end
+    end # def wrap_soap
+    
+    class JiraException < RuntimeError
+    end
+    
+    class NoSuchIssueException < JiraException
+      
+    end
+    
+  end # module Exceptions
+end # module BetterJira

data/lib/better_jira/jira.rb

@@ -0,0 +1,240 @@
+require 'soap/wsdlDriver'
+require 'better_jira/utils'
+
+module BetterJira
+  class Jira
+    # Construct the object
+    #
+    # @param [String] jira_url the base url to your jira instance, ie: https://jira.mycompany.com
+    # @param [String] trust_ca the path to a PEM file that contains a CA certificate to trust
+    def initialize(jira_url, trust_ca = nil) 
+      @jira_url = jira_url
+      @soap = SOAP::WSDLDriverFactory.new(@jira_url + "/rpc/soap/jirasoapservice-v2?wsdl").create_rpc_driver
+      @client = HTTPClient.new
+      @client.ssl_config.set_trust_ca(trust_ca) unless trust_ca.nil?
+    end
+    
+    # Login to the jira instance
+    #
+    # @param [String] username your username
+    # @param [String] password your password
+    #
+    # @raise if login fails
+    def login(username, password)
+      @token = @soap.login(username, password)
+    
+      destination = '/success'
+      res = @client.post("#{@jira_url}/secure/Dashboard.jspa", {
+        'os_username' => username,
+        'os_password' => password,
+        'os_destination' => destination
+      })
+      raise "Login Fail!" if res.status != 302 || (res.header['Location'] && res.header['Location'].first[-destination.length, destination.length] != destination)
+    end
+
+    # Retrieves all the fields available for edit on the particular issue key
+    #
+    # @param [String] key the issue key to check (ie: TEST-100)
+    # @return [Hash] a hash of jira field id to name
+    def fields_for_edit(key)
+      BetterJira::simple_soap_mapping(@soap.getFieldsForEdit(@token, key))
+    end
+
+    # Iterates over all the issues in a filter, passing each JiraIssue into the block
+    #
+    # @param [Integer] filter_id the filter to load
+    # @param [Hash] options the options to use when iterating
+    # @option options [Integer] :batch_size (50) the number of issues to retrieve at a time
+    # @option options [Integer] :exclude_if_in_filter (nil) a filter to use as an exclude list if present
+    # @yield a block for iterating over the list
+    # @yieldparam [JiraIssue] issue
+    def each_issue_from_filter(filter_id, options ={}, &block)
+      options[:batch_size] ||= 50
+    
+      exclude_issues = []
+    
+      if (options[:exclude_if_in_filter]) then
+        each_issue_from_filter(options[:exclude_if_in_filter]) { |issue|
+          exclude_issues << issue[:key]
+        }
+      end
+
+      offset = 0
+      while( (issues = @soap.getIssuesFromFilterWithLimit(@token, filter_id, offset, options[:batch_size])) != nil) 
+        break if offset >= @soap.getIssueCountForFilter(@token, filter_id) 
+        offset += issues.length
+      
+        issues.each {|issue|
+          issue = JiraIssue.new(issue, self)
+          block.call(issue) unless exclude_issues.include?(issue[:key])
+        }
+      end
+    end
+    
+    # Retrieves all of the versions for a particular project from the Jira server
+    #
+    # @param [String] project_key the project key to look up, ie: "MYPROJ"
+    def versions_for_project(project_key)
+      @soap.getVersions(@token, project_key).map{|x| BetterJira::JiraVersion.convert_from_soap(x)}
+    end
+  
+    def update_issue(key, remote_field_changes)
+      @soap.updateIssue(@token, key, remote_field_changes)
+    end
+  
+    def convert_custom_field_value_to_happy_jira_time(value)
+      if (value != nil) then
+        if (Array === value) then
+          value = value.map { |x| 
+            q = nil
+            q = x if String === x
+            q = x['id'] if SOAP::Mapping::Object === x
+            q
+          }
+        elsif (SOAP::Mapping::Object === value) then
+          value = [value['id']]
+        elsif (String === value) then
+          value = [value]
+        elsif (DateTime === value) then
+          value = [value.strftime('%d/%b/%y')]
+        end
+      end
+    end
+  
+    def progress_workflow(key, workflow_action_id, custom_field_values, opts = {})
+      puts "Shit passed in" if JIRA_DEBUG
+      puts "==============" if JIRA_DEBUG
+      p custom_field_values if JIRA_DEBUG
+      puts "" if JIRA_DEBUG
+    
+    
+    
+      cfvs = []
+      
+      unless @client.nil?
+        res = @client.get("#{@jira_url}/si/jira.issueviews:issue-xml/#{key}/#{key}.xml")
+        puts res.content if JIRA_DEBUG
+        match = res.content.match(/<timeestimate seconds="(.*?)">(.*?)<\/timeestimate>/)
+        time_estimate = "#{match[1].to_i/60}" unless match.nil?
+      end
+    
+    
+      issue = get_issue(key)
+      fields = fields_for_action(key, workflow_action_id)
+    
+      puts "Issue" if JIRA_DEBUG
+      p issue if JIRA_DEBUG
+      puts "" if JIRA_DEBUG
+    
+      moronic_map = {
+        'issuetype' => 'type',
+        'versions' => 'affectsVersions'
+      }
+        puts "Fields" if JIRA_DEBUG
+        puts "======" if JIRA_DEBUG
+      fields.each {|f|
+
+        p f if JIRA_DEBUG
+        real_field_name = moronic_map[f['id']] ? moronic_map[f['id']] : f['id']
+      
+        if (real_field_name != '' && custom_field_values[real_field_name.to_sym] != nil)
+          value = custom_field_values[real_field_name.to_sym]
+        elsif (real_field_name != '' && custom_field_values[real_field_name] != nil)
+          value = custom_field_values[real_field_name]
+        elsif (real_field_name == 'timetracking') then
+          value = time_estimate
+        elsif (real_field_name =~ /customfield_/) then
+          q = issue.customFieldValues.find { |c| c.customfieldId == real_field_name }
+          value = q.values unless q.nil?
+        else
+          value = nil
+          value = issue.send('[]', real_field_name) if not real_field_name.empty?
+        end
+      
+        value = convert_custom_field_value_to_happy_jira_time(value)
+      
+        puts "" if JIRA_DEBUG
+        p value if JIRA_DEBUG
+        puts "" if JIRA_DEBUG
+      
+        cfvs << {:id => f['id'], :values => value}
+      }
+    
+      puts "Output!" if JIRA_DEBUG
+      puts "=======" if JIRA_DEBUG
+      p cfvs if JIRA_DEBUG
+    
+    
+    
+      @soap.progressWorkflowAction(@token, key, workflow_action_id, cfvs)
+    end
+
+    # Adds a comment to the issue specified by key
+    #
+    # @param [String] key the issue to comment on
+    # @param [String] comment the comment to use
+    # @param [Hash] options
+    # @option options [String] :body the comment body to use, shouldn't be used
+    # @option options [String] :groupLevel ?
+    # @option options [String] :roleLevel ?
+    def add_comment(key, comment, options={})
+      options[:body] = comment if options[:body].nil?
+    
+      @soap.addComment(@token, key, options)
+    end
+  
+    # Gets the available actions for an issue from the server
+    #
+    # @param [String] key the issue to look up
+    #
+    # @return [Hash] keys are the jira id, values are the name of the action
+    def available_actions(key)
+      BetterJira::Exceptions.wrap_soap {
+        BetterJira::simple_soap_mapping(@soap.getAvailableActions(@token, key))
+      }
+    end
+  
+    # Gets the specified issue from the jira server
+    #
+    # @param [String] key the issue key
+    # @return [JiraIssue] the retrieved jira issue
+    def get_issue(key)
+      JiraIssue.new(@soap.getIssue(@token, key), self)
+    end
+  
+    # Gets the specified issue from the jira server
+    # @see #get_issue
+    def [](key)
+      get_issue(key)
+    end
+
+    # Gets the available fields for edit during an action
+    #
+    # @param [String] key the issue to look up
+    # @param [Integer] action_id the action to look up
+    #
+    # @return [Hash] keys are the jira id, values are the name of the field
+    def fields_for_action(key, action_id)
+      BetterJira::Exceptions.wrap_soap {
+        BetterJira::simple_soap_mapping(@soap.getFieldsForAction(@token, key, action_id))
+      }
+    end
+  
+    def map_version_fields(project, fields, cur_depth = 0, versions = nil)
+      versions = versions_for_project(project)
+    
+      if (cur_depth == 0 && Array === fields) then
+        fields.map { |q|
+          map_version_fields(project, q, cur_depth + 1, versions)
+        }.flatten
+      elsif (Fixnum === fields || Integer === fields)
+        [fields.to_s]
+      elsif (String === fields)
+        versions = versions.select { |version| version.name == fields }
+        versions = versions.map { |version| version['id'] }
+      end
+    end
+  end # class Jira
+
+
+end # module BetterJira

data/lib/better_jira/jira_issue.rb

@@ -0,0 +1,99 @@
+module BetterJira
+  class JiraIssue
+    attr_reader :custom_fields
+  
+    FIELDS = [:summary, :description]
+  
+    def initialize(soap_jira_issue, jira)
+      @soap_jira_issue = soap_jira_issue
+      @jira = jira
+      @changes = []
+      @custom_fields = {}
+      @soap_jira_issue.customFieldValues.each { |cf|
+        @custom_fields[cf.customfieldId] = cf.values
+      }
+    end
+
+    def update_fields(fields)
+      fields[:fixVersions] = fields[:fix_versions] if fields.has_key? :fix_versions
+      fields[:versions] = fields[:affects_versions] if fields.has_key? :affects_versions
+    
+      fields.each {|k,v|
+        case k
+          when :fixVersions then
+            fields[k] = @jira.map_version_fields(self[:project], v)
+          when :versions
+            fields[k] = @jira.map_version_fields(self[:project], v)
+        end
+      }
+    
+    
+      fields = fields.map {|k,v|
+        {:id => k, :values => BetterJira::convert_custom_field_value_to_happy_jira_time(v)}
+      }
+      @jira.update_issue(self[:key], fields)
+      initialize(@jira.get_issue(self[:key]), @jira)
+    end
+    
+    def field_value(key)
+      r = self[key]
+      r = r.first unless (r.nil?)
+      return r
+    end
+  
+    def field_values(key)
+      self[key]
+    end
+  
+    def [](key)
+      if (key.to_s =~ /customfield_/) then
+        BetterJira::custom_field_values(@soap_jira_issue, key.to_s)
+      elsif (Symbol === key) then
+        begin
+          @soap_jira_issue.send "[]", key.to_s
+        rescue NoMethodError => e
+          nil
+        end
+      else
+      
+      end
+    end
+  
+    def field_as_date_time(key)
+      BetterJira::custom_field_value_as_date_time(@soap_jira_issue, key.to_s)
+    end
+  
+    # Returns a list of available actions for this issue
+    def available_actions
+      ret = {}
+      @jira.available_actions(self[:key]).each{|q| ret[q['id']] = q['name']}
+      ret
+    end
+    
+    # Returns a list of fields for a particular action_id
+    def fields_for_action_id(action_id)
+      ret = {}
+      @jira.fields_for_action(self[:key], action_id).each {|q| ret[q['id']] = q['name']}
+      ret
+    end
+  
+    # Adds a comment to the issue
+    def add_comment(comment, options={})
+      @jira.add_comment(self[:key], comment, options)
+    end
+  
+    def fields_for_action_name(action_name)
+      action = available_actions.find {|k, v| v == action_name}
+      fields_for_action_id(action[0])
+    end
+  
+  
+    def fields_for_edit
+      BetterJira::array_of_remote_fields_to_map(@jira.get_fields_for_edit(self[:key]))
+    end
+  
+    def progress_workflow(workflow_action_id, custom_field_values, opts = {})
+      @jira.progress_workflow(self[:key], workflow_action_id, custom_field_values, opts)
+    end
+  end # class JiraIssue
+end

data/lib/better_jira/jira_version.rb

@@ -0,0 +1,19 @@
+module BetterJira
+  class JiraVersion
+    attr_accessor :archived, :id, :name, :release_date, :released, :sequence
+    
+    def self.convert_from_soap(s)
+      if (s.is_a? SOAP::Mapping::Object) then
+        ret = JiraVersion.new
+        ret.archived = s.archived
+        ret.id = s.id
+        ret.name = s.name
+        ret.release_date = s.releaseDate
+        ret.released = s.released
+        ret.sequence = s.sequence
+        ret
+      end
+    end
+
+  end
+end # module BetterJira

data/lib/better_jira/net_http_ssl_hack.rb

@@ -0,0 +1,12 @@
+# Hack for SSL issues
+require 'net/http'
+
+class Net::HTTP
+  alias_method :old_initialize, :initialize
+  def initialize(*args)
+    old_initialize(*args)
+    @ssl_context = OpenSSL::SSL::SSLContext.new
+    @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  end
+end
+# /Hack for SSL issues

data/lib/better_jira/utils.rb

@@ -0,0 +1,63 @@
+module BetterJira
+  def self.custom_field_values(issue, field) 
+    issue.customFieldValues.each { |cfv|
+      if (cfv.customfieldId == field) then
+        return cfv.values
+      end
+    }
+  
+    return nil
+  end
+
+  def self.custom_field_value(issue, field, &block) 
+    if (block == nil) then
+      block = Proc.new {|x| x}
+    end
+  
+    values = custom_field_values(issue, field)
+  
+    return block.call(values.first) if (values != nil)
+
+    return nil
+  end
+
+  def self.custom_field_value_as_date_time(issue, field)
+    custom_field_value(issue, field) { |x| DateTime.parse(x, true) }
+  end
+  
+  # Converts an array of RemoteFields into a map of id => name
+  #
+  # @return [Hash] the converted map
+  def self.array_of_remote_fields_to_map(remote_fields)
+    ret = {}
+    remote_fields.each{|q| ret[q['id']] = q['name']}
+    ret
+  end
+  
+  def self.simple_soap_mapping(a)
+    ret = {}
+    a.each{|q| ret[q['id']] = q['name']}
+    ret
+  end
+  
+  def self.convert_custom_field_value_to_happy_jira_time(value)
+    if (value != nil) then
+      if (Array === value) then
+        value = value.map { |x| 
+          q = nil
+          q = x if String === x
+          q = x['id'] if SOAP::Mapping::Object === x
+          q
+        }
+      elsif (SOAP::Mapping::Object === value) then
+        value = [value['id']]
+      elsif (String === value) then
+        value = [value]
+      elsif (DateTime === value) then
+        value = [value.strftime('%d/%b/%y')]
+      else
+        value = [value.to_s]
+      end
+    end
+  end
+end

data/lib/better_jira/version.rb

@@ -0,0 +1,23 @@
+# Copyright (c) 2010 Eric Anderson
+# 
+# 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.
+
+module BetterJira
+  VERSION = "0.0.1"
+end

data/lib/better_jira.rb

@@ -0,0 +1,5 @@
+require 'better_jira/core_ext'
+require 'better_jira/utils'
+require 'better_jira/jira'
+require 'better_jira/jira_issue'
+require 'better_jira/exceptions'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: better_jira
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Eric Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 5
+        - 2
+        version: 2.1.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: soap4r
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 8
+        version: 1.5.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: 
+- eric@ericanderson.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/better_jira/core_ext.rb
+- lib/better_jira/exceptions.rb
+- lib/better_jira/jira.rb
+- lib/better_jira/jira_issue.rb
+- lib/better_jira/jira_version.rb
+- lib/better_jira/net_http_ssl_hack.rb
+- lib/better_jira/utils.rb
+- lib/better_jira/version.rb
+- lib/better_jira.rb
+has_rdoc: true
+homepage: http://github.com/ericanderson/better_jira
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Yet Another Jira Gem
+test_files: []
+