Add support for Jira Issue Properties

lib/jira-ruby.rb

@@ -23,6 +23,7 @@
 require 'jira/resource/status_category'
 require 'jira/resource/transition'
 require 'jira/resource/project'
+require 'jira/resource/properties'
 require 'jira/resource/priority'
 require 'jira/resource/comment'
 require 'jira/resource/worklog'

lib/jira/client.rb

@@ -302,6 +302,10 @@ def Agile
       JIRA::Resource::AgileFactory.new(self)
     end
 
+    def Properties
+      JIRA::Resource::PropertiesFactory.new(self)
+    end
+
     # HTTP methods without a body
 
     # Make an HTTP DELETE request
@@ -351,7 +355,9 @@ def post(path, body = '', headers = {})
     # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def post_multipart(path, file, headers = {})
       puts "post multipart: #{path} - [#{file}]" if @http_debug
-      @request_client.request_multipart(path, file, merge_default_headers(headers))
+      res = @request_client.request_multipart(path, file, merge_default_headers(headers))
+      puts "response: #{res}" if @http_debug
+      res
     end
 
     # Make an HTTP PUT request
@@ -375,7 +381,9 @@ def put(path, body = '', headers = {})
     # @raise [JIRA::HTTPError] If the response is not an HTTP success code
     def request(http_method, path, body = '', headers = {})
       puts "#{http_method}: #{path} - [#{body}]" if @http_debug
-      @request_client.request(http_method, path, body, headers)
+      res = @request_client.request(http_method, path, body, headers)
+      puts "response: #{res}" if @http_debug
+      res
     end
 
     # @private

lib/jira/resource/attachment.rb

@@ -146,10 +146,14 @@ def download_contents(headers = {})
       # @raise [JIRA::HTTPError] if failed
       def save!(attrs, path = url)
         file = attrs['file'] || attrs[:file] # Keep supporting 'file' parameter as a string for backward compatibility
-        mime_type = attrs[:mimeType] || 'application/binary'
+        # If :filename does not exist or is nil, that is fine as it will force
+        # Upload to determine the filename automatically from file.
+        # Breaking the filename out allows this to support any IO-based file parameter.
+        fname = attrs['filename'] || attrs[:filename]
+        mime_type = attrs['mimeType'] || attrs[:mimeType] || 'application/binary'
 
         headers = { 'X-Atlassian-Token' => 'nocheck' }
-        data = { 'file' => Multipart::Post::UploadIO.new(file, mime_type, file) }
+        data = { 'file' => Multipart::Post::UploadIO.new(file, mime_type, fname) }
 
         response = client.post_multipart(path, data, headers)
 
@@ -159,6 +163,17 @@ def save!(attrs, path = url)
         true
       end
 
+      def http_download
+        # Actually fetch the attachment
+        # Note: Jira handles attachment's weird!
+        # Typically, they respond with a redirect location that should not have the same authentication
+        client.get(attrs['content'])
+      rescue JIRA::HTTPError => e
+        raise e unless e.response.code =~ /\A3\d\d\z/ && e.response['location'].present?
+
+        Net::HTTP.get_response(URI(e.response['location']))
+      end
+
       private
 
       def set_attributes(attributes, response)

lib/jira/resource/comment.rb

@@ -9,6 +9,18 @@ class Comment < JIRA::Base
       belongs_to :issue
 
       nested_collections true
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        raise ArgumentError, 'parent issue is required' unless issue
+
+        response = client.get("#{issue.url}/#{endpoint_name}")
+        json = parse_json(response.body)
+        json = json[endpoint_name.pluralize]
+        json.map do |attrs|
+          new(client, { attrs: }.merge(options))
+        end
+      end
     end
   end
 end

lib/jira/resource/issue.rb

@@ -57,6 +57,7 @@ class Issue < JIRA::Base
       has_many :issuelinks, nested_under: 'fields'
       has_many :remotelink, class: JIRA::Resource::Remotelink
       has_many :watchers, attribute_key: 'watches', nested_under: %w[fields watches]
+      has_many :properties, class: JIRA::Resource::Properties
 
       # Get collection of issues.
       # @param client [JIRA::Client]

lib/jira/resource/properties.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'active_support/inflector'
+
+module JIRA
+  module Resource
+    class PropertiesFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Properties < JIRA::Base
+      belongs_to :issue
+
+      def self.key_attribute
+        :key
+      end
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        raise ArgumentError, 'parent issue is required' unless issue
+
+        response = client.get("#{issue.url}/#{endpoint_name}")
+        json = parse_json(response.body)
+        json[key_attribute.to_s.pluralize].map do |attrs|
+          ## Net get the individual property
+          self_response = client.get(attrs['self'])
+          property = parse_json(self_response.body)
+          ## Make sure to build the new resource via the issue.properties in order to support the has_many proxy
+          issue.properties.build(property)
+        end
+      end
+
+      ## Override save so we can handle the required attrs (and default 'value' when appropriate)
+      def save!(attrs = {}, path = nil)
+        if attrs.is_a?(Hash) && attrs.key?(self.class.key_attribute.to_s)
+          raise ArgumentError, "Use of 'value' is required when '#{self.class.key_attribute}' is provided" \
+            unless attrs.key?('value')
+
+          set_attrs(self.class.key_attribute.to_s => attrs[self.class.key_attribute.to_s])
+        end
+
+        raise ArgumentError, "'key' is required on a new record" if new_record?
+
+        path ||= patched_url
+        ## We can take either the 'value' element from the hash, OR use the entire attrs as the value
+        value = attrs.is_a?(Hash) && attrs.key?('value') ? attrs['value'] : attrs
+        value = '' if value.nil?
+        ## Note: this API endpoint requires a non-empty JSON body for the value of the property
+        ## Note2: this API endpoint does not return a body, so no need to call set_attrs_from_response
+        client.send(:put, path, value.to_json)
+        set_attrs({ 'value' => value }, false)
+        @expanded = false
+        true
+      end
+    end
+  end
+end

lib/jira/resource/worklog.rb

@@ -10,6 +10,18 @@ class Worklog < JIRA::Base
       has_one :update_author, class: JIRA::Resource::User, attribute_key: 'updateAuthor'
       belongs_to :issue
       nested_collections true
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        raise ArgumentError, 'parent issue is required' unless issue
+
+        response = client.get("#{issue.url}/#{endpoint_name}")
+        json = parse_json(response.body)
+        json = json[endpoint_name.pluralize]
+        json.map do |attrs|
+          new(client, { attrs: }.merge(options))
+        end
+      end
     end
   end
 end

lib/jira/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JIRA
-  VERSION = '3.0.0'
+  VERSION = '3.0.1-dh1'
 end

spec/integration/properties_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Properties do
+  with_each_client do |site_url, client|
+    context 'when accessing singular resource' do
+      let(:client) { client }
+      let(:site_url) { site_url }
+      let(:key) { 'xyz' }
+      let(:target) { described_class.new(client, attrs: { 'key' => 'xyz' }, issue_id: '10002') }
+      let(:belongs_to) { JIRA::Resource::Issue.new(client, attrs: { 'id' => '10002' }) }
+      let(:expected_attributes) { { 'key' => key, 'value' => 'supercalifragilistic' } }
+      let(:attributes_for_put) { { 'value' => 'expialidocious' } }
+      let(:expected_attributes_from_put) { { 'key' => key, 'value' => 'expialidocious' } }
+
+      it_behaves_like 'a resource'
+      it_behaves_like 'a resource with a singular GET endpoint'
+      it_behaves_like 'a resource with a DELETE endpoint'
+      it_behaves_like 'a resource with a PUT endpoint'
+    end
+
+    context 'when accessing collection' do
+      let(:client) { client }
+      let(:site_url) { site_url }
+      let(:key) { 'xyz' }
+      let(:belongs_to) { JIRA::Resource::Issue.new(client, attrs: { 'id' => '10002' }) }
+      let(:expected_collection_length) { 2 }
+      let(:expected_attributes) { { 'key' => key, 'value' => 'supercalifragilistic' } }
+
+      before do
+        ## Since properties collections do subsequent queries on each individual properties records,
+        ## we need to additionally define stub requests for each of the individual records
+        additional_targets = [
+          described_class.new(client, attrs: { 'key' => 'foo' }, issue_id: '10002'),
+          described_class.new(client, attrs: { 'key' => 'xyz' }, issue_id: '10002')
+        ]
+        additional_targets.each do |target|
+          req_url = site_url + target.url
+          stub_request(:get, req_url).to_return(status: 200, body: get_mock_from_url(:get, req_url))
+        end
+      end
+
+      it_behaves_like 'a resource with a collection GET endpoint'
+    end
+  end
+end

spec/integration/transition_spec.rb

@@ -38,9 +38,10 @@
 
     describe 'POST endpoint' do
       it 'saves a new resource' do
-        stub_request(:post, /#{described_class.collection_path(client, prefix)}$/)
+        req_url = build_url
+        stub_request(:post, req_url)
           .with(body: attributes_for_post.to_json)
-          .to_return(status: 200, body: get_mock_from_path(:post))
+          .to_return(status: 200, body: get_mock_from_url(:post, req_url))
         subject = build_receiver.build
         expect(subject.save(attributes_for_post)).to be_truthy
       end

spec/integration/webhook_spec.rb

@@ -1,7 +1,9 @@
 require 'spec_helper'
 
 describe JIRA::Resource::Webhook do
-  with_each_client do |site_url, client|
+  ## This endpoint uses a different base path, so override this client's rest_base_path option
+  ## so this test can still use the SharedExampleGroups
+  with_each_client(rest_base_path: described_class.const_get(:REST_BASE_PATH)) do |site_url, client|
     let(:client) { client }
     let(:site_url) { site_url }
 
@@ -20,7 +22,7 @@
 
     it 'returns a collection of components' do
       stub_request(:get, site_url + described_class.singular_path(client, key))
-        .to_return(status: 200, body: get_mock_response('webhook/webhook.json'))
+        .to_return(status: 200, body: get_mock_response('webhook/2.json'))
 
       webhook = client.Webhook.find(key)
 

spec/jira/resource/issue_spec.rb

@@ -210,7 +210,8 @@ class JIRAResourceDelegation < SimpleDelegator # :nodoc:
                               'comment' => { 'comments' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }] },
                               'attachment' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }],
                               'worklog' => { 'worklogs' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }] }
-                            }
+                            },
+                            'properties' => [{ 'foo' => 'bar' }, { 'baz' => 'flum' }]
                           })
     end
 
@@ -250,6 +251,9 @@ class JIRAResourceDelegation < SimpleDelegator # :nodoc:
 
       expect(subject).to have_many(:worklogs, JIRA::Resource::Worklog)
       expect(subject.worklogs.length).to eq(2)
+
+      expect(subject).to have_many(:properties, JIRA::Resource::Properties)
+      expect(subject.properties.length).to eq(2)
     end
   end
 end

spec/mock_responses/issue/10002/properties.json

@@ -0,0 +1,12 @@
+{
+  "keys": [
+    {
+      "key": "xyz",
+      "self": "http://localhost:2990/jira/rest/api/2/issue/10002/properties/xyz"
+    },
+    {
+      "key": "foo",
+      "self": "http://localhost:2990/jira/rest/api/2/issue/10002/properties/foo"
+    }
+  ]
+}

spec/mock_responses/issue/10002/properties/foo.json

@@ -0,0 +1,4 @@
+{
+  "key": "foo",
+  "value": "bar"
+}

spec/mock_responses/issue/10002/properties/xyz.json

@@ -0,0 +1,4 @@
+{
+  "key": "xyz",
+  "value": "supercalifragilistic"
+}

spec/mock_responses/issue/10002/properties/xyz.put.json

@@ -0,0 +1,4 @@
+{
+  "key": "xyz",
+  "value": "expialidocious"
+}

spec/support/clients_helper.rb

@@ -1,12 +1,12 @@
 module ClientsHelper
-  def with_each_client(&)
+  def with_each_client(opts = {}, &)
     clients = {}
 
-    oauth_client = JIRA::Client.new(consumer_key: 'foo', consumer_secret: 'bar')
+    oauth_client = JIRA::Client.new({ consumer_key: 'foo', consumer_secret: 'bar' }.merge(opts))
     oauth_client.set_access_token('abc', '123')
     clients['http://localhost:2990'] = oauth_client
 
-    basic_client = JIRA::Client.new(username: 'foo', password: 'bar', auth_type: :basic, use_ssl: false)
+    basic_client = JIRA::Client.new({ username: 'foo', password: 'bar', auth_type: :basic, use_ssl: false }.merge(opts))
     clients['http://localhost:2990'] = basic_client
 
     clients.each(&)