jira-ruby 2.1.3

data/lib/jira/resource/remotelink.rb

@@ -0,0 +1,26 @@
+module JIRA
+  module Resource
+    class RemotelinkFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Remotelink < JIRA::Base
+      belongs_to :issue
+
+      def self.endpoint_name
+        'remotelink'
+      end
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        raise ArgumentError, 'parent issue is required' unless issue
+
+        path = "#{issue.self}/#{endpoint_name}"
+        response = client.get(path)
+        json = parse_json(response.body)
+        json.map do |link|
+          issue.remotelink.build(link)
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/resolution.rb

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

data/lib/jira/resource/serverinfo.rb

@@ -0,0 +1,18 @@
+module JIRA
+  module Resource
+    class ServerInfoFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class ServerInfo < JIRA::Base
+      def self.endpoint_name
+        'serverInfo'
+      end
+
+      def self.all(client, options = {})
+        response = client.get(collection_path(client))
+        json = parse_json(response.body)
+        new(client, { attrs: json }.merge(options))
+      end
+    end
+  end
+end

data/lib/jira/resource/sprint.rb

@@ -0,0 +1,105 @@
+module JIRA
+  module Resource
+    class SprintFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Sprint < JIRA::Base
+      def self.find(client, key)
+        response = client.get(agile_path(client, key))
+        json = parse_json(response.body)
+        client.Sprint.build(json)
+      end
+
+      # get all issues of sprint
+      def issues(options = {})
+        jql = 'sprint = ' + id.to_s
+        jql += " and updated >= '#{options[:updated]}'" if options[:updated]
+        Issue.jql(client, jql)
+      end
+
+      def add_issue(issue)
+        request_body = { issues: [issue.id] }.to_json
+        response = client.post("#{agile_path}/issue", request_body)
+        true
+      end
+
+      def sprint_report
+        get_sprint_details_attribute('sprint_report')
+      end
+
+      def start_date
+        get_sprint_details_attribute('start_date')
+      end
+
+      def end_date
+        get_sprint_details_attribute('end_date')
+      end
+
+      def complete_date
+        get_sprint_details_attribute('complete_date')
+      end
+
+      def get_sprint_details_attribute(attribute_name)
+        attribute = instance_variable_get("@#{attribute_name}")
+        return attribute if attribute
+        get_sprint_details
+        instance_variable_get("@#{attribute_name}")
+      end
+
+      def get_sprint_details
+        search_url =
+          "#{client.options[:site]}#{client.options[:client_path]}/rest/greenhopper/1.0/rapid/charts/sprintreport?rapidViewId=#{rapidview_id}&sprintId=#{id}"
+        begin
+          response = client.get(search_url)
+        rescue StandardError
+          return nil
+        end
+        json = self.class.parse_json(response.body)
+
+        @start_date = Date.parse(json['sprint']['startDate']) unless json['sprint']['startDate'] == 'None'
+        @end_date = Date.parse(json['sprint']['endDate']) unless json['sprint']['endDate'] == 'None'
+        @completed_date = Date.parse(json['sprint']['completeDate']) unless json['sprint']['completeDate'] == 'None'
+        @sprint_report = client.SprintReport.build(json['contents'])
+      end
+
+      def rapidview_id
+        return @attrs['rapidview_id'] if @attrs['rapidview_id']
+        search_url = client.options[:site] + '/secure/GHGoToBoard.jspa?sprintId=' + id.to_s
+        begin
+          response = client.get(search_url)
+        rescue JIRA::HTTPError => error
+          return unless error.response.instance_of? Net::HTTPFound
+          rapid_view_match = /rapidView=(\d+)&/.match(error.response['location'])
+          @attrs['rapidview_id'] = rapid_view_match[1] unless rapid_view_match.nil?
+        end
+      end
+
+      def save(attrs = {}, _path = nil)
+        attrs = @attrs if attrs.empty?
+        super(attrs, agile_path)
+      end
+
+      def save!(attrs = {}, _path = nil)
+        attrs = @attrs if attrs.empty?
+        super(attrs, agile_path)
+      end
+
+      # WORK IN PROGRESS
+      def complete
+        complete_url = "#{client.options[:site]}/rest/greenhopper/1.0/sprint/#{id}/complete"
+        response = client.put(complete_url)
+        self.class.parse_json(response.body)
+      end
+
+      private
+
+      def agile_path
+        self.class.agile_path(client, id)
+      end
+
+      def self.agile_path(client, key)
+        "#{client.options[:context_path]}/rest/agile/1.0/sprint/#{key}"
+      end
+    end
+  end
+end

data/lib/jira/resource/sprint_report.rb

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

data/lib/jira/resource/status.rb

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

data/lib/jira/resource/transition.rb

@@ -0,0 +1,29 @@
+module JIRA
+  module Resource
+    class TransitionFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Transition < JIRA::Base
+      has_one :to, class: JIRA::Resource::Status
+      belongs_to :issue
+
+      nested_collections true
+
+      def self.endpoint_name
+        'transitions'
+      end
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        raise ArgumentError, 'parent issue is required' unless issue
+
+        path = "#{issue.self}/#{endpoint_name}?expand=transitions.fields"
+        response = client.get(path)
+        json = parse_json(response.body)
+        json['transitions'].map do |transition|
+          issue.transitions.build(transition)
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/user.rb

@@ -0,0 +1,30 @@
+module JIRA
+  module Resource
+    class UserFactory < JIRA::BaseFactory # :nodoc:
+      def myself
+        instance = build
+        response = client.get("#{client.options[:rest_base_path]}/myself")
+        instance.set_attrs_from_response(response)
+        instance
+      end
+    end
+
+    class User < JIRA::Base
+      MAX_RESULTS = 1000
+
+      def self.singular_path(client, key, prefix = '/')
+        collection_path(client, prefix) + '?username=' + key
+      end
+
+      # Cannot retrieve more than 1,000 users through the api, please see: https://jira.atlassian.com/browse/JRASERVER-65089
+      def self.all(client)
+        response  = client.get("/rest/api/2/user/search?username=_&maxResults=#{MAX_RESULTS}")
+        all_users = JSON.parse(response.body)
+
+        all_users.flatten.uniq.map do |user|
+          client.User.build(user)
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/version.rb

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

data/lib/jira/resource/watcher.rb

@@ -0,0 +1,35 @@
+module JIRA
+  module Resource
+    class WatcherFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Watcher < JIRA::Base
+      belongs_to :issue
+
+      nested_collections true
+
+      def self.endpoint_name
+        'watchers'
+      end
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        raise ArgumentError, 'parent issue is required' unless issue
+
+        path = "#{issue.self}/#{endpoint_name}"
+        response = client.get(path)
+        json = parse_json(response.body)
+        json['watchers'].map do |watcher|
+          issue.watchers.build(watcher)
+        end
+      end
+
+      def save!(user_id, path = nil)
+        path ||= new_record? ? url : patched_url
+        response = client.post(path, user_id.to_json)
+        true
+      end
+
+    end
+  end
+end

data/lib/jira/resource/webhook.rb

@@ -0,0 +1,37 @@
+module JIRA
+  module Resource
+    class WebhookFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Webhook < JIRA::Base
+      REST_BASE_PATH = '/rest/webhooks/1.0'.freeze
+
+      def self.endpoint_name
+        'webhook'
+      end
+
+      def self.full_url(client)
+        client.options[:context_path] + REST_BASE_PATH
+      end
+
+      def self.collection_path(client, prefix = '/')
+        full_url(client) + prefix + endpoint_name
+      end
+
+      def self.all(client, options = {})
+        response = client.get(collection_path(client))
+        json = parse_json(response.body)
+        json.map do |attrs|
+          new(client, { attrs: attrs }.merge(options))
+        end
+      end
+
+      # def self.save(options={})
+      # end
+
+      # def self.delete(options={})
+
+      # end
+    end
+  end
+end

data/lib/jira/resource/worklog.rb

@@ -0,0 +1,14 @@
+module JIRA
+  module Resource
+    class WorklogFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Worklog < JIRA::Base
+      has_one :author, class: JIRA::Resource::User
+      has_one :update_author, class: JIRA::Resource::User,
+                              attribute_key: 'updateAuthor'
+      belongs_to :issue
+      nested_collections true
+    end
+  end
+end

data/lib/jira/version.rb

@@ -0,0 +1,3 @@
+module JIRA
+  VERSION = '2.1.3'.freeze
+end

data/lib/tasks/generate.rake

@@ -0,0 +1,18 @@
+require 'securerandom'
+
+namespace :jira do
+  desc 'Generate a consumer key for your application'
+  task :generate_consumer_key do
+    key = SecureRandom.hex(16)
+    puts "You can use this as your consumer key: #{key}"
+  end
+
+  desc 'Run the system call to generate a RSA public certificate'
+  task :generate_public_cert do
+    puts "Executing 'openssl req -x509 -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem'"
+    system('openssl req -x509 -subj "/C=US/ST=New York/L=New York/O=SUMO Heavy Industries/CN=www.sumoheavy.com" -nodes -newkey rsa:1024 -sha1 -keyout rsakey.pem -out rsacert.pem')
+    puts "Done. The RSA-SHA1 private keyfile is in the current directory: \'rsakey.pem\'."
+    puts 'You will need to copy the following certificate into your application link configuration in Jira:'
+    system('cat rsacert.pem')
+  end
+end

data/spec/integration/attachment_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Attachment do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { '10000' }
+
+    let(:target) { JIRA::Resource::Attachment.new(client, attrs: { 'id' => '99999' }, issue_id: '10002') }
+
+    let(:expected_attributes) do
+      {
+        'self' => 'http://localhost:2990/jira/rest/api/2/attachment/10000',
+        'size' => 15_360,
+        'filename' => 'ballmer.png'
+      }
+    end
+
+    let(:belongs_to) do
+      JIRA::Resource::Issue.new(client, attrs: {
+                                  'id' => '10002',
+                                  'fields' => {
+                                    'attachment' => { 'attachments' => [] }
+                                  }
+                                })
+    end
+
+    it_should_behave_like 'a resource with a singular GET endpoint'
+    it_should_behave_like 'a resource with a DELETE endpoint'
+  end
+end

data/spec/integration/comment_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Comment do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { '10000' }
+
+    let(:target) { JIRA::Resource::Comment.new(client, attrs: { 'id' => '99999' }, issue_id: '54321') }
+
+    let(:expected_collection_length) { 2 }
+
+    let(:belongs_to) do
+      JIRA::Resource::Issue.new(client, attrs: {
+                                  'id' => '10002',
+                                  'fields' => {
+                                    'comment' => { 'comments' => [] }
+                                  }
+                                })
+    end
+
+    let(:expected_attributes) do
+      {
+        'self' => 'http://localhost:2990/jira/rest/api/2/issue/10002/comment/10000',
+        'id'   => key,
+        'body' => 'This is a comment. Creative.'
+      }
+    end
+
+    let(:attributes_for_post) do
+      { 'body' => 'new comment' }
+    end
+    let(:expected_attributes_from_post) do
+      { 'id' => '10001', 'body' => 'new comment' }
+    end
+
+    let(:attributes_for_put) do
+      { 'body' => 'new body' }
+    end
+    let(:expected_attributes_from_put) do
+      { 'id' => '10000', 'body' => 'new body' }
+    end
+
+    it_should_behave_like 'a resource'
+    it_should_behave_like 'a resource with a collection GET endpoint'
+    it_should_behave_like 'a resource with a singular GET endpoint'
+    it_should_behave_like 'a resource with a DELETE endpoint'
+    it_should_behave_like 'a resource with a POST endpoint'
+    it_should_behave_like 'a resource with a PUT endpoint'
+  end
+end