jira-ruby 1.2.0 → 2.3.0

data/lib/jira/resource/sprint.rb

@@ -1,36 +1,105 @@
-require 'cgi'
-
 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
 
-      def self.all(client, key)
-        response = client.get(path_base(client) + '/sprintquery/' + key.to_s)
-        parse_json(response.body)
+      # 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 self.find(client, key, options = {})
-        options[:maxResults] ||= 100
-        fields = options[:fields].join(',') unless options[:fields].nil?
-        response = client.get("/rest/api/latest/search?jql=sprint=#{key}&fields=#{fields}&maxResults=#{options[:maxResults]}")
-        parse_json(response.body)
+      def add_issue(issue)
+        request_body = { issues: [issue.id] }.to_json
+        response = client.post("#{agile_path}/issue", request_body)
+        true
       end
 
-      private
+      def sprint_report
+        get_sprint_details_attribute('sprint_report')
+      end
 
-      def self.path_base(client)
-        client.options[:context_path] + '/rest/greenhopper/1.0'
+      def start_date
+        get_sprint_details_attribute('start_date')
       end
 
-      def path_base(client)
-        self.class.path_base(client)
+      def end_date
+        get_sprint_details_attribute('end_date')
       end
 
-    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

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

data/lib/jira/resource/suggested_issue.rb

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

data/lib/jira/resource/transition.rb

@@ -1,11 +1,10 @@
 module JIRA
   module Resource
-
     class TransitionFactory < JIRA::BaseFactory # :nodoc:
     end
 
     class Transition < JIRA::Base
-      has_one :to, :class => JIRA::Resource::Status
+      has_one :to, class: JIRA::Resource::Status
       belongs_to :issue
 
       nested_collections true
@@ -16,9 +15,7 @@ module JIRA
 
       def self.all(client, options = {})
         issue = options[:issue]
-        unless issue
-          raise ArgumentError.new("parent issue is required")
-        end
+        raise ArgumentError, 'parent issue is required' unless issue
 
         path = "#{issue.self}/#{endpoint_name}?expand=transitions.fields"
         response = client.get(path)
@@ -28,6 +25,5 @@ module JIRA
         end
       end
     end
-
   end
 end

data/lib/jira/resource/user.rb

@@ -1,6 +1,5 @@
 module JIRA
   module Resource
-
     class UserFactory < JIRA::BaseFactory # :nodoc:
       def myself
         instance = build
@@ -11,10 +10,21 @@ module JIRA
     end
 
     class User < JIRA::Base
+      MAX_RESULTS = 1000
+
       def self.singular_path(client, key, prefix = '/')
         collection_path(client, prefix) + '?username=' + key
       end
-    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/users/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

@@ -1,10 +1,8 @@
 module JIRA
   module Resource
-
     class VersionFactory < JIRA::BaseFactory # :nodoc:
     end
 
-    class Version < JIRA::Base ; 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

@@ -1,12 +1,10 @@
 module JIRA
   module Resource
-
     class WebhookFactory < JIRA::BaseFactory # :nodoc:
     end
 
     class Webhook < JIRA::Base
-
-      REST_BASE_PATH = '/rest/webhooks/1.0'
+      REST_BASE_PATH = '/rest/webhooks/1.0'.freeze
 
       def self.endpoint_name
         'webhook'
@@ -17,14 +15,14 @@ module JIRA
       end
 
       def self.collection_path(client, prefix = '/')
-        self.full_url(client) + prefix + self.endpoint_name
+        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|
-          self.new(client, {:attrs => attrs}.merge(options))
+          new(client, { attrs: attrs }.merge(options))
         end
       end
 
@@ -34,7 +32,6 @@ module JIRA
       # def self.delete(options={})
 
       # end
-
     end
   end
 end

data/lib/jira/resource/worklog.rb

@@ -1,16 +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"
+      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

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "1.2.0"
+  VERSION = '2.3.0'.freeze
 end

data/lib/jira-ruby.rb

@@ -1,5 +1,6 @@
-$: << File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH << __dir__
 
+require 'active_support'
 require 'active_support/inflector'
 ActiveSupport::Inflector.inflections do |inflector|
   inflector.singular /status$/, 'status'
@@ -11,6 +12,7 @@ require 'jira/has_many_proxy'
 require 'jira/http_error'
 
 require 'jira/resource/user'
+require 'jira/resource/watcher'
 require 'jira/resource/attachment'
 require 'jira/resource/component'
 require 'jira/resource/issuetype'
@@ -24,7 +26,12 @@ require 'jira/resource/worklog'
 require 'jira/resource/applinks'
 require 'jira/resource/issuelinktype'
 require 'jira/resource/issuelink'
+require 'jira/resource/suggested_issue'
+require 'jira/resource/issue_picker_suggestions_issue'
+require 'jira/resource/issue_picker_suggestions'
 require 'jira/resource/remotelink'
+require 'jira/resource/sprint'
+require 'jira/resource/sprint_report'
 require 'jira/resource/issue'
 require 'jira/resource/filter'
 require 'jira/resource/field'
@@ -34,10 +41,13 @@ require 'jira/resource/serverinfo'
 require 'jira/resource/createmeta'
 require 'jira/resource/webhook'
 require 'jira/resource/agile'
-require 'jira/resource/sprint'
+require 'jira/resource/board'
+require 'jira/resource/board_configuration'
+
 require 'jira/request_client'
 require 'jira/oauth_client'
 require 'jira/http_client'
+require 'jira/jwt_client'
 require 'jira/client'
 
 require 'jira/railtie' if defined?(Rails)

data/lib/tasks/generate.rake

@@ -1,18 +1,18 @@
 require 'securerandom'
 
 namespace :jira do
-  desc "Generate a consumer key for your application"
+  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"
+  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")
+    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

@@ -1,23 +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(: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' => 15360,
-        'filename' => "ballmer.png"
+        'self' => 'http://localhost:2990/jira/rest/api/2/attachment/10000',
+        'size' => 15_360,
+        'filename' => 'ballmer.png'
       }
     end
 
-    it_should_behave_like "a resource"
-    it_should_behave_like "a resource with a singular GET endpoint"
-    it_should_behave_like "a resource with a DELETE endpoint"
+    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

@@ -1,55 +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(:key) { '10000' }
 
-    let(:target) { JIRA::Resource::Comment.new(client, :attrs => {'id' => '99999'}, :issue_id => '54321') }
+    let(:target) { JIRA::Resource::Comment.new(client, attrs: { 'id' => '99999' }, issue_id: '54321') }
 
     let(:expected_collection_length) { 2 }
 
-    let(:belongs_to) {
-      JIRA::Resource::Issue.new(client, :attrs => {
-        'id' => '10002',
-        'fields' => {
-          'comment' => {'comments' => []}
-        }
-      })
-    }
+    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",
+        'self' => 'http://localhost:2990/jira/rest/api/2/issue/10002/comment/10000',
         'id'   => key,
-        'body' => "This is a comment. Creative."
+        'body' => 'This is a comment. Creative.'
       }
     end
 
-    let(:attributes_for_post) {
-      { "body" => "new comment" }
-    }
-    let(:expected_attributes_from_post) {
-      { "id" => "10001", "body" => "new comment"}
-    }
-
-    let(:attributes_for_put) {
-      {"body" => "new body"}
-    }
-    let(:expected_attributes_from_put) {
-      { "id" => "10000", "body" => "new body" }
-    }
-
-    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"
+    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

data/spec/integration/component_spec.rb

@@ -1,42 +1,39 @@
 require 'spec_helper'
 
 describe JIRA::Resource::Component do
-
-
   with_each_client do |site_url, client|
     let(:client) { client }
     let(:site_url) { site_url }
 
-    let(:key) { "10000" }
+    let(:key) { '10000' }
 
     let(:expected_attributes) do
       {
-        'self' => "http://localhost:2990/jira/rest/api/2/component/10000",
+        'self' => 'http://localhost:2990/jira/rest/api/2/component/10000',
         'id'   => key,
-        'name' => "Cheesecake"
+        'name' => 'Cheesecake'
       }
     end
 
-    let(:attributes_for_post) {
-      {"name" => "Test component", "project" => "SAMPLEPROJECT" }
-    }
-    let(:expected_attributes_from_post) {
-      { "id" => "10001", "name" => "Test component" }
-    }
-
-    let(:attributes_for_put) {
-      {"name" => "Jammy", "project" => "SAMPLEPROJECT" }
-    }
-    let(:expected_attributes_from_put) {
-      { "id" => "10000", "name" => "Jammy" }
-    }
+    let(:attributes_for_post) do
+      { 'name' => 'Test component', 'project' => 'SAMPLEPROJECT' }
+    end
+    let(:expected_attributes_from_post) do
+      { 'id' => '10001', 'name' => 'Test component' }
+    end
 
-    it_should_behave_like "a resource"
-    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"
-    it_should_behave_like "a resource with a PUT endpoint that rejects invalid fields"
+    let(:attributes_for_put) do
+      { 'name' => 'Jammy', 'project' => 'SAMPLEPROJECT' }
+    end
+    let(:expected_attributes_from_put) do
+      { 'id' => '10000', 'name' => 'Jammy' }
+    end
 
+    it_should_behave_like 'a resource'
+    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'
+    it_should_behave_like 'a resource with a PUT endpoint that rejects invalid fields'
   end
 end

data/spec/integration/field_spec.rb

@@ -1,35 +1,32 @@
 require 'spec_helper'
 
 describe JIRA::Resource::Field do
-
   with_each_client do |site_url, client|
     let(:client) { client }
     let(:site_url) { site_url }
 
-
-    let(:key) { "1" }
+    let(:key) { '1' }
 
     let(:expected_attributes) do
       {
-        "id"=>key,
-        "name"=>"Description",
-        "custom"=>false,
-        "orderable"=>true,
-        "navigable"=>true,
-        "searchable"=>true,
-        "clauseNames"=>["description"],
-        "schema"=>  {
-                      "type"=>"string",
-                      "system"=>"description"
-                    }
+        'id' => key,
+        'name' => 'Description',
+        'custom' => false,
+        'orderable' => true,
+        'navigable' => true,
+        'searchable' => true,
+        'clauseNames' => ['description'],
+        'schema' => {
+          'type' => 'string',
+          'system' => 'description'
+        }
       }
     end
 
     let(:expected_collection_length) { 2 }
 
-    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'
+    it_should_behave_like 'a resource with a collection GET endpoint'
+    it_should_behave_like 'a resource with a singular GET endpoint'
   end
 end