Class: JIRA::Resource::Issue

Inherits:
Base
  • Object
show all
Defined in:
lib/jira/resource/issuelink.rb,
lib/jira/resource/issue.rb

Overview

Because of circular dependency Issue->IssueLink->Issue we have to declare JIRA::Resource::Issue class.

Constant Summary

Constants inherited from Base

Base::QUERY_PARAMS_FOR_SEARCH, Base::QUERY_PARAMS_FOR_SINGLE_FETCH

Instance Attribute Summary

Attributes inherited from Base

#attrs, #client, #deleted, #expanded

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

belongs_to, belongs_to_relationships, build, collection_attributes_are_nested, collection_path, #collection_path, #delete, endpoint_name, #fetch, find, #has_errors?, has_many, has_one, #id, #initialize, key_attribute, #key_value, nested_collections, #new_record?, parse_json, #patched_url, #path_component, #save, #save!, #set_attrs, #set_attrs_from_response, singular_path, #to_json, #to_s, #to_sym, #url

Constructor Details

This class inherits a constructor from JIRA::Base

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, &block) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/jira/resource/issue.rb', line 90

def method_missing(method_name, *args, &block)
  if attrs.keys.include?('fields')
    if attrs['fields'].keys.include?(method_name.to_s)
      attrs['fields'][method_name.to_s]
    else
      official_name=client.Field.name_to_id(method_name)
      if attrs['fields'].keys.include?(official_name)
        attrs['fields'][official_name]
      else
        super(method_name, *args, &block)
      end
    end
  else
    super(method_name, *args, &block)
  end
end

Class Method Details

.all(client) ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/jira/resource/issue.rb', line 42

def self.all(client)
  url = client.options[:rest_base_path] + "/search?expand=transitions.fields"
  response = client.get(url)
  json = parse_json(response.body)
  json['issues'].map do |issue|
    client.Issue.build(issue)
  end
end

.jql(client, jql, options = {fields: nil, start_at: nil, max_results: nil, expand: nil, validate_query: true}) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/jira/resource/issue.rb', line 51

def self.jql(client, jql, options = {fields: nil, start_at: nil, max_results: nil, expand: nil, validate_query: true})
  url = client.options[:rest_base_path] + "/search?jql=#{CGI.escape(jql)}"

  url << "&fields=#{options[:fields].map{ |value| CGI.escape(client.Field.name_to_id(value)) }.join(',')}" if options[:fields]
  url << "&startAt=#{CGI.escape(options[:start_at].to_s)}" if options[:start_at]
  url << "&maxResults=#{CGI.escape(options[:max_results].to_s)}" if options[:max_results]
  url << "&validateQuery=false" if options[:validate_query] === false

  if options[:expand]
    options[:expand] = [options[:expand]] if options[:expand].is_a?(String)
    url << "&expand=#{options[:expand].to_a.map{ |value| CGI.escape(value.to_s) }.join(',')}"
  end

  response = client.get(url)
  json = parse_json(response.body)
  if options[:max_results] and options[:max_results] == 0
    return json['total']
  end
  json['issues'].map do |issue|
    client.Issue.build(issue)
  end
end

Instance Method Details

#editmeta ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/jira/resource/issue.rb', line 74

def editmeta
  editmeta_url = client.options[:rest_base_path] + "/#{self.class.endpoint_name}/#{key}/editmeta"

  response = client.get(editmeta_url)
  json = self.class.parse_json(response.body)
  json['fields']
end

#respond_to?(method_name, include_all = false) ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
85
86
87
88
 
# File 'lib/jira/resource/issue.rb', line 82

def respond_to?(method_name, include_all=false)
  if attrs.keys.include?('fields') && [method_name.to_s, client.Field.name_to_id(method_name)].any? {|k| attrs['fields'].key?(k)}
    true
  else
    super(method_name)
  end
end