jira-ruby 2.1.3

data/lib/jira/resource/board_configuration.rb

@@ -0,0 +1,9 @@
+module JIRA
+  module Resource
+    class BoardConfigurationFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class BoardConfiguration < JIRA::Base
+    end
+  end
+end

data/lib/jira/resource/comment.rb

@@ -0,0 +1,12 @@
+module JIRA
+  module Resource
+    class CommentFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Comment < JIRA::Base
+      belongs_to :issue
+
+      nested_collections true
+    end
+  end
+end

data/lib/jira/resource/component.rb

@@ -0,0 +1,8 @@
+module JIRA
+  module Resource
+    class ComponentFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Component < JIRA::Base; end
+  end
+end

data/lib/jira/resource/createmeta.rb

@@ -0,0 +1,44 @@
+module JIRA
+  module Resource
+    class CreatemetaFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Createmeta < JIRA::Base
+      def self.endpoint_name
+        '/issue/createmeta'
+      end
+
+      def self.all(client, params = {})
+        if params.key?(:projectKeys)
+          values = Array(params[:projectKeys]).map { |i| (i.is_a?(JIRA::Resource::Project) ? i.key : i) }
+          params[:projectKeys] = values.join(',')
+        end
+
+        if params.key?(:projectIds)
+          values = Array(params[:projectIds]).map { |i| (i.is_a?(JIRA::Resource::Project) ? i.id : i) }
+          params[:projectIds] = values.join(',')
+        end
+
+        if params.key?(:issuetypeNames)
+          values = Array(params[:issuetypeNames]).map { |i| (i.is_a?(JIRA::Resource::Issuetype) ? i.name : i) }
+          params[:issuetypeNames] = values.join(',')
+        end
+
+        if params.key?(:issuetypeIds)
+          values = Array(params[:issuetypeIds]).map { |i| (i.is_a?(JIRA::Resource::Issuetype) ? i.id : i) }
+          params[:issuetypeIds] = values.join(',')
+        end
+
+        create_meta_url = client.options[:rest_base_path] + endpoint_name
+        params = hash_to_query_string(params)
+
+        response = params.empty? ? client.get(create_meta_url.to_s) : client.get("#{create_meta_url}?#{params}")
+
+        json = parse_json(response.body)
+        json['projects'].map do |attrs|
+          new(client, attrs: attrs)
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/field.rb

@@ -0,0 +1,83 @@
+module JIRA
+  module Resource
+    class FieldFactory < JIRA::BaseFactory # :nodoc:
+      delegate_to_target_class :map_fields, :name_to_id, :field_map
+    end
+
+    class Field < JIRA::Base
+      # translate a custom field description to a method-safe name
+      def self.safe_name(description)
+        description.gsub(/[^a-zA-Z0-9]/, '_')
+      end
+
+      # safe_name plus disambiguation if it fails it uses the original jira id (customfield_#####)
+      def self.safer_name(description, jira_id)
+        "#{safe_name(description)}_#{jira_id.split('_')[1]}"
+      rescue StandardError
+        jira_id
+      end
+
+      def self.map_fields(client)
+        field_map = {}
+        field_map_reverse = {}
+        fields = client.Field.all
+
+        # two pass approach, so that a custom field with the same name
+        # as a system field can't take precedence
+        fields.each do |f|
+          next if f.custom
+          name = safe_name(f.name)
+          field_map_reverse[f.id] = [f.name, name] # capture both the official name, and the mapped name
+          field_map[name] = f.id
+        end
+
+        fields.each do |f|
+          next unless f.custom
+          name = if field_map.key? f.name
+                   renamed = safer_name(f.name, f.id)
+                   warn "Duplicate Field name #{f.name} #{f.id} - renaming as #{renamed}"
+                   renamed
+                 else
+                   safe_name(f.name)
+          end
+          field_map_reverse[f.id] = [f.name, name] # capture both the official name, and the mapped name
+          field_map[name] = f.id
+        end
+
+        client.cache.field_map_reverse = field_map_reverse # not sure where this will be used yet, but sure to be useful
+        client.cache.field_map = field_map
+      end
+
+      def self.field_map(client)
+        client.cache.field_map
+      end
+
+      def self.name_to_id(client, field_name)
+        field_name = field_name.to_s
+        return field_name unless client.cache.field_map && client.cache.field_map[field_name]
+        client.cache.field_map[field_name]
+      end
+
+      def respond_to?(method_name, _include_all = false)
+        if [method_name.to_s, client.Field.name_to_id(method_name)].any? { |k| attrs.key?(k) }
+          true
+        else
+          super(method_name)
+        end
+      end
+
+      def method_missing(method_name, *args, &block)
+        if attrs.key?(method_name.to_s)
+          attrs[method_name.to_s]
+        else
+          official_name = client.Field.name_to_id(method_name)
+          if attrs.key?(official_name)
+            attrs[official_name]
+          else
+            super(method_name, *args, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/filter.rb

@@ -0,0 +1,15 @@
+module JIRA
+  module Resource
+    class FilterFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Filter < JIRA::Base
+      has_one :owner, class: JIRA::Resource::User
+
+      # Returns all the issues for this filter
+      def issues
+        Issue.jql(client, jql)
+      end
+    end
+  end
+end

data/lib/jira/resource/issue.rb

@@ -0,0 +1,141 @@
+require 'cgi'
+require 'json'
+
+module JIRA
+  module Resource
+    class IssueFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Issue < JIRA::Base
+      has_one :reporter,  class: JIRA::Resource::User,
+                          nested_under: 'fields'
+      has_one :assignee,  class: JIRA::Resource::User,
+                          nested_under: 'fields'
+      has_one :project,   nested_under: 'fields'
+
+      has_one :issuetype, nested_under: 'fields'
+
+      has_one :priority,  nested_under: 'fields'
+
+      has_one :status,    nested_under: 'fields'
+
+      has_many :transitions
+
+      has_many :components, nested_under: 'fields'
+
+      has_many :comments, nested_under: %w[fields comment]
+
+      has_many :attachments, nested_under: 'fields',
+                             attribute_key: 'attachment'
+
+      has_many :versions,    nested_under: 'fields'
+      has_many :fixVersions, class: JIRA::Resource::Version,
+                             nested_under: 'fields'
+
+      has_many :worklogs, nested_under: %w[fields worklog]
+      has_one :sprint, class: JIRA::Resource::Sprint,
+                       nested_under: 'fields'
+
+      has_many :closed_sprints, class: JIRA::Resource::Sprint,
+                                nested_under: 'fields', attribute_key: 'closedSprints'
+
+      has_many :issuelinks, nested_under: 'fields'
+
+      has_many :remotelink, class: JIRA::Resource::Remotelink
+
+      has_many :watchers,   attribute_key: 'watches',
+                            nested_under: %w[fields watches]
+
+      def self.all(client)
+        start_at = 0
+        max_results = 1000
+        result = []
+        loop do
+          url = client.options[:rest_base_path] +
+                "/search?expand=transitions.fields&maxResults=#{max_results}&startAt=#{start_at}"
+          response = client.get(url)
+          json = parse_json(response.body)
+          json['issues'].map do |issue|
+            result.push(client.Issue.build(issue))
+          end
+          break if json['issues'].empty?
+          start_at += json['issues'].size
+        end
+        result
+      end
+
+      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] && (options[:max_results] == 0)
+          return json['total']
+        end
+        json['issues'].map do |issue|
+          client.Issue.build(issue)
+        end
+      end
+
+      # Fetches the attributes for the specified resource from JIRA unless
+      # the resource is already expanded and the optional force reload flag
+      # is not set
+      def fetch(reload = false, query_params = {})
+        return if expanded? && !reload
+        response = client.get(url_with_query_params(url, query_params))
+        set_attrs_from_response(response)
+        if @attrs && @attrs['fields'] && @attrs['fields']['worklog'] && (@attrs['fields']['worklog']['total'] > @attrs['fields']['worklog']['maxResults'])
+          worklog_url = client.options[:rest_base_path] + "/#{self.class.endpoint_name}/#{id}/worklog"
+          response = client.get(worklog_url)
+          unless response.body.nil? || (response.body.length < 2)
+            set_attrs({ 'fields' => { 'worklog' => self.class.parse_json(response.body) } }, false)
+          end
+        end
+        @expanded = true
+      end
+
+      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
+
+      def respond_to?(method_name, _include_all = false)
+        if attrs.key?('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
+
+      def method_missing(method_name, *args, &block)
+        if attrs.key?('fields')
+          if attrs['fields'].key?(method_name.to_s)
+            attrs['fields'][method_name.to_s]
+          else
+            official_name = client.Field.name_to_id(method_name)
+            if attrs['fields'].key?(official_name)
+              attrs['fields'][official_name]
+            else
+              super(method_name, *args, &block)
+            end
+          end
+        else
+          super(method_name, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/issuelink.rb

@@ -0,0 +1,20 @@
+module JIRA
+  module Resource
+    class IssuelinkFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    # Because of circular dependency Issue->IssueLink->Issue
+    # we have to declare JIRA::Resource::Issue class.
+    class Issue < JIRA::Base; end
+
+    class Issuelink < JIRA::Base
+      has_one :type, class: JIRA::Resource::Issuelinktype
+      has_one :inwardIssue, class: JIRA::Resource::Issue
+      has_one :outwardIssue, class: JIRA::Resource::Issue
+
+      def self.endpoint_name
+        'issueLink'
+      end
+    end
+  end
+end

data/lib/jira/resource/issuelinktype.rb

@@ -0,0 +1,14 @@
+module JIRA
+  module Resource
+    class IssuelinktypeFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Issuelinktype < JIRA::Base
+      nested_collections true
+
+      def self.endpoint_name
+        'issueLinkType'
+      end
+    end
+  end
+end

data/lib/jira/resource/issuetype.rb

@@ -0,0 +1,8 @@
+module JIRA
+  module Resource
+    class IssuetypeFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Issuetype < JIRA::Base; end
+  end
+end

data/lib/jira/resource/priority.rb

@@ -0,0 +1,8 @@
+module JIRA
+  module Resource
+    class PriorityFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Priority < JIRA::Base; end
+  end
+end

data/lib/jira/resource/project.rb

@@ -0,0 +1,41 @@
+module JIRA
+  module Resource
+    class ProjectFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Project < JIRA::Base
+      has_one :lead, class: JIRA::Resource::User
+      has_many :components
+      has_many :issuetypes, attribute_key: 'issueTypes'
+      has_many :versions
+
+      def self.key_attribute
+        :key
+      end
+
+      # Returns all the issues for this project
+      def issues(options = {})
+        search_url = client.options[:rest_base_path] + '/search'
+        query_params = { jql: "project=\"#{key}\"" }
+        query_params.update Base.query_params_for_search(options)
+        response = client.get(url_with_query_params(search_url, query_params))
+        json = self.class.parse_json(response.body)
+        json['issues'].map do |issue|
+          client.Issue.build(issue)
+        end
+      end
+
+      def users(start_at: nil, max_results: nil)
+        users_url = client.options[:rest_base_path] + '/user/assignable/search'
+        query_params = { project: key_value }
+        query_params['startAt'] = start_at if start_at
+        query_params['maxResults'] = max_results if max_results
+        response = client.get(url_with_query_params(users_url, query_params))
+        json = self.class.parse_json(response.body)
+        json.map do |jira_user|
+          client.User.build(jira_user)
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/rapidview.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+
+module JIRA
+  module Resource
+    class RapidViewFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class RapidView < JIRA::Base
+      def self.all(client)
+        response = client.get(path_base(client) + '/rapidview')
+        json = parse_json(response.body)
+        json['views'].map do |view|
+          client.RapidView.build(view)
+        end
+      end
+
+      def self.find(client, key, _options = {})
+        response = client.get(path_base(client) + "/rapidview/#{key}")
+        json = parse_json(response.body)
+        client.RapidView.build(json)
+      end
+
+      def issues(options = {})
+        response = client.get(path_base(client) + "/xboard/plan/backlog/data?rapidViewId=#{id}")
+        json = self.class.parse_json(response.body)
+        # To get Issue objects with the same structure as for Issue.all
+        issue_ids = json['issues'].map { |issue| issue['id'] }
+
+        # First we have to get all IDs of parent and sub tasks
+        jql = "id IN(#{issue_ids.join(', ')})"
+
+        # Filtering options
+        jql << ' AND sprint IS NOT EMPTY' unless options[:include_backlog_items]
+
+        parent_issues = client.Issue.jql(jql)
+        subtask_ids = parent_issues.map { |t| t.subtasks.map { |sub| sub['id'] } }.flatten
+
+        parent_and_sub_ids = parent_issues.map(&:id) + subtask_ids
+        jql = "id IN(#{parent_and_sub_ids.join(', ')})"
+        jql << " and updated >= '#{options.delete(:updated)}'" if options[:updated]
+
+        client.Issue.jql(jql)
+      end
+
+      def sprints(options = {})
+        params = { includeHistoricSprints: options.fetch(:include_historic, false),
+                   includeFutureSprints:   options.fetch(:include_future, false) }
+        response = client.get(path_base(client) + "/sprintquery/#{id}?#{params.to_query}")
+        json = self.class.parse_json(response.body)
+        json['sprints'].map do |sprint|
+          sprint['rapidview_id'] = id
+          client.Sprint.build(sprint)
+        end
+      end
+
+      private
+
+      def self.path_base(client)
+        client.options[:context_path] + '/rest/greenhopper/1.0'
+      end
+
+      def path_base(client)
+        self.class.path_base(client)
+      end
+    end
+  end
+end