jira-ruby 1.2.0 → 2.3.0

data/spec/mock_responses/board/1_issues.json

@@ -0,0 +1,62 @@
+{
+  "expand": "schema,names",
+  "startAt": 0,
+  "maxResults": 1000,
+  "total": 9,
+  "issues": [
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10546",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10546",
+      "key": "SBT-1"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10547",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10547",
+      "key": "SBT-2"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10556",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10556",
+      "key": "SBT-11"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10557",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10557",
+      "key": "SBT-12"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10558",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10558",
+      "key": "SBT-13"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10559",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10559",
+      "key": "SBT-14"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10600",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10600",
+      "key": "SBT-16"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10601",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10601",
+      "key": "SBT-17"
+    },
+    {
+      "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
+      "id": "10604",
+      "self": "https://jira.example.com/rest/agile/1.0/issue/10604",
+      "key": "SBT-19"
+    }
+  ]
+}

data/spec/mock_responses/empty_issues.json

@@ -0,0 +1,8 @@
+{
+  "expand": "schema,names",
+  "startAt": 11,
+  "maxResults": 1000,
+  "total": 0,
+  "issues": [
+  ]
+}

data/spec/mock_responses/issue/10002/watchers.json

@@ -0,0 +1,13 @@
+{
+    "self": "http://localhost:2990/jira/rest/api/2/issue/10002/watchers",
+    "isWatching": false,
+    "watchCount": 1,
+    "watchers": [
+        {
+            "self": "http://www.example.com/jira/rest/api/2/user?username=admin",
+            "name": "admin",
+            "displayName": "admin",
+            "active": false
+        }
+    ]
+}

data/spec/mock_responses/issue.json

@@ -1,7 +1,7 @@
 {
   "expand": "schema,names",
   "startAt": 0,
-  "maxResults": 50,
+  "maxResults": 1000,
   "total": 11,
   "issues": [
     {

data/spec/mock_responses/sprint/1_issues.json

@@ -0,0 +1,125 @@
+{
+  "expand": "schema,names",
+  "startAt": 0,
+  "maxResults": 50,
+  "total": 1,
+  "issues": [
+    {
+      "expand": "",
+      "id": "10001",
+      "self": "http://www.example.com/jira/rest/agile/1.0/board/92/issue/10001",
+      "key": "HSP-1",
+      "fields": {
+        "flagged": true,
+        "sprint": {
+          "id": 37,
+          "self": "http://www.example.com/jira/rest/agile/1.0/sprint/13",
+          "state": "future",
+          "name": "sprint 2"
+        },
+        "closedSprints": [
+          {
+            "id": 37,
+            "self": "http://www.example.com/jira/rest/agile/1.0/sprint/23",
+            "state": "closed",
+            "name": "sprint 1",
+            "startDate": "2015-04-11T15:22:00.000+10:00",
+            "endDate": "2015-04-20T01:22:00.000+10:00",
+            "completeDate": "2015-04-20T11:04:00.000+10:00"
+          }
+        ],
+        "description": "example bug report",
+        "project": {
+          "self": "http://www.example.com/jira/rest/api/2/project/EX",
+          "id": "10000",
+          "key": "EX",
+          "name": "Example",
+          "avatarUrls": {
+            "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000",
+            "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000",
+            "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000",
+            "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000"
+          },
+          "projectCategory": {
+            "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000",
+            "id": "10000",
+            "name": "FIRST",
+            "description": "First Project Category"
+          }
+        },
+        "comment": [
+          {
+            "self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000",
+            "id": "10000",
+            "author": {
+              "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+              "name": "fred",
+              "displayName": "Fred F. User",
+              "active": false
+            },
+            "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
+            "updateAuthor": {
+              "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+              "name": "fred",
+              "displayName": "Fred F. User",
+              "active": false
+            },
+            "created": "2016-06-22T11:49:57.797+0200",
+            "updated": "2016-06-22T11:49:57.800+0200",
+            "visibility": {
+              "type": "role",
+              "value": "Administrators"
+            }
+          }
+        ],
+        "epic": {
+          "id": 37,
+          "self": "http://www.example.com/jira/rest/agile/1.0/epic/23",
+          "name": "epic 1",
+          "summary": "epic 1 summary",
+          "color": {
+            "key": "color_4"
+          },
+          "done": true
+        },
+        "worklog": [
+          {
+            "self": "http://www.example.com/jira/rest/api/2/issue/10010/worklog/10000",
+            "author": {
+              "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+              "name": "fred",
+              "displayName": "Fred F. User",
+              "active": false
+            },
+            "updateAuthor": {
+              "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
+              "name": "fred",
+              "displayName": "Fred F. User",
+              "active": false
+            },
+            "comment": "I did some work here.",
+            "updated": "2016-06-22T11:49:57.804+0200",
+            "visibility": {
+              "type": "group",
+              "value": "jira-developers"
+            },
+            "started": "2016-06-22T11:49:57.804+0200",
+            "timeSpent": "3h 20m",
+            "timeSpentSeconds": 12000,
+            "id": "100028",
+            "issueId": "10002"
+          }
+        ],
+        "updated": 1,
+        "timetracking": {
+          "originalEstimate": "10m",
+          "remainingEstimate": "3m",
+          "timeSpent": "6m",
+          "originalEstimateSeconds": 600,
+          "remainingEstimateSeconds": 200,
+          "timeSpentSeconds": 400
+        }
+      }
+    }
+  ]
+}

data/spec/spec_helper.rb

@@ -2,7 +2,9 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'rubygems'
 require 'bundler/setup'
 require 'webmock/rspec'
-Dir["./spec/support/**/*.rb"].each {|f| require f}
+require 'pry'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
 
 require 'jira-ruby'
 
@@ -10,13 +12,10 @@ RSpec.configure do |config|
   config.extend ClientsHelper
 end
 
-
 def get_mock_response(file, value_if_file_not_found = false)
-  begin
-    file.sub!('?', '_') # we have to replace this character on Windows machine
-    File.read(File.join(File.dirname(__FILE__), 'mock_responses/', file))
-  rescue Errno::ENOENT => e
-    raise e if value_if_file_not_found == false
-    value_if_file_not_found
-  end
+  file.sub!('?', '_') # we have to replace this character on Windows machine
+  File.read(File.join(File.dirname(__FILE__), 'mock_responses/', file))
+rescue Errno::ENOENT => e
+  raise e if value_if_file_not_found == false
+  value_if_file_not_found
 end

data/spec/support/clients_helper.rb

@@ -2,12 +2,12 @@ module ClientsHelper
   def with_each_client
     clients = {}
 
-    oauth_client = JIRA::Client.new({ :consumer_key => 'foo', :consumer_secret => 'bar' })
+    oauth_client = JIRA::Client.new(consumer_key: 'foo', consumer_secret: 'bar')
     oauth_client.set_access_token('abc', '123')
-    clients["http://localhost:2990"] = oauth_client
+    clients['http://localhost:2990'] = oauth_client
 
-    basic_client = JIRA::Client.new({ :username => 'foo', :password => 'bar', :auth_type => :basic, :use_ssl => false })
-    clients["http://foo:bar@localhost:2990"] = basic_client
+    basic_client = JIRA::Client.new(username: 'foo', password: 'bar', auth_type: :basic, use_ssl: false)
+    clients['http://foo:bar@localhost:2990'] = basic_client
 
     clients.each do |site_url, client|
       yield site_url, client

data/spec/support/shared_examples/integration.rb

@@ -1,43 +1,39 @@
 require 'cgi'
 
 def get_mock_from_path(method, options = {})
-  if defined? belongs_to
-    prefix = belongs_to.path_component + '/'
-  else
-    prefix = ''
-  end
-
-  if options[:url]
-    url = options[:url]
-  elsif options[:key]
-    url = described_class.singular_path(client, options[:key], prefix)
-  else
-    url = described_class.collection_path(client, prefix)
-  end
+  prefix = if defined? belongs_to
+             belongs_to.path_component + '/'
+           else
+             ''
+           end
+
+  url = if options[:url]
+          options[:url]
+        elsif options[:key]
+          described_class.singular_path(client, options[:key], prefix)
+        else
+          described_class.collection_path(client, prefix)
+        end
   file_path = url.sub(client.options[:rest_base_path], '')
   file_path = file_path + '.' + options[:suffix] if options[:suffix]
   file_path = file_path + '.' + method.to_s unless method == :get
-  value_if_not_found = options.keys.include?(:value_if_not_found) ? options[:value_if_not_found] : false
+  value_if_not_found = options.key?(:value_if_not_found) ? options[:value_if_not_found] : false
   get_mock_response("#{file_path}.json", value_if_not_found)
 end
 
 def class_basename
- described_class.name.split('::').last
+  described_class.name.split('::').last
 end
 
 def options
   options = {}
-  if defined? belongs_to
-    options[belongs_to.to_sym] = belongs_to
-  end
+  options[belongs_to.to_sym] = belongs_to if defined? belongs_to
   options
 end
 
 def prefix
   prefix = '/'
-  if defined? belongs_to
-    prefix = belongs_to.path_component + '/'
-  end
+  prefix = belongs_to.path_component + '/' if defined? belongs_to
   prefix
 end
 
@@ -49,73 +45,66 @@ def build_receiver
   end
 end
 
-shared_examples "a resource" do
-
-  it "gracefully handles non-json responses" do
+shared_examples 'a resource' do
+  it 'gracefully handles non-json responses' do
     if defined? target
       subject = target
     else
       subject = client.send(class_basename).build(described_class.key_attribute.to_s => '99999')
     end
-    stub_request(:put, site_url + subject.url).
-                to_return(:status => 405, :body => "<html><body>Some HTML</body></html>")
+    stub_request(:put, site_url + subject.url)
+      .to_return(status: 405, body: '<html><body>Some HTML</body></html>')
     expect(subject.save('foo' => 'bar')).to be_falsey
     expect(lambda do
       expect(subject.save!('foo' => 'bar')).to be_falsey
     end).to raise_error(JIRA::HTTPError)
   end
-
 end
 
-shared_examples "a resource with a collection GET endpoint" do
-
-  it "should get the collection" do
-    stub_request(:get, site_url + described_class.collection_path(client)).
-                 to_return(:status => 200, :body => get_mock_from_path(:get))
+shared_examples 'a resource with a collection GET endpoint' do
+  it 'should get the collection' do
+    stub_request(:get, site_url + described_class.collection_path(client))
+      .to_return(status: 200, body: get_mock_from_path(:get))
     collection = build_receiver.all
 
     expect(collection.length).to eq(expected_collection_length)
     expect(collection.first).to have_attributes(expected_attributes)
   end
-
 end
 
-shared_examples "a resource with JQL inputs and a collection GET endpoint" do
-
-  it "should get the collection" do
+shared_examples 'a resource with JQL inputs and a collection GET endpoint' do
+  it 'should get the collection' do
     stub_request(
       :get,
       site_url +
         client.options[:rest_base_path] +
         '/search?jql=' +
         CGI.escape(jql_query_string)
-    ).to_return(:status => 200, :body => get_mock_response('issue.json'))
+    ).to_return(status: 200, body: get_mock_response('issue.json'))
 
     collection = build_receiver.jql(jql_query_string)
 
     expect(collection.length).to eq(expected_collection_length)
     expect(collection.first).to have_attributes(expected_attributes)
   end
-
 end
 
-shared_examples "a resource with a singular GET endpoint" do
-
-  it "GETs a single resource" do
+shared_examples 'a resource with a singular GET endpoint' do
+  it 'GETs a single resource' do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.find()
-    stub_request(:get, site_url + described_class.singular_path(client, key, prefix)).
-                to_return(:status => 200, :body => get_mock_from_path(:get, :key => key))
+    stub_request(:get, site_url + described_class.singular_path(client, key, prefix))
+      .to_return(status: 200, body: get_mock_from_path(:get, key: key))
     subject = client.send(class_basename).find(key, options)
 
     expect(subject).to have_attributes(expected_attributes)
   end
 
-  it "builds and fetches a single resource" do
+  it 'builds and fetches a single resource' do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.build('key' => 'ABC123')
-    stub_request(:get, site_url + described_class.singular_path(client, key, prefix)).
-                to_return(:status => 200, :body => get_mock_from_path(:get, :key => key))
+    stub_request(:get, site_url + described_class.singular_path(client, key, prefix))
+      .to_return(status: 200, body: get_mock_from_path(:get, key: key))
 
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
     subject.fetch
@@ -123,48 +112,45 @@ shared_examples "a resource with a singular GET endpoint" do
     expect(subject).to have_attributes(expected_attributes)
   end
 
-  it "handles a 404" do
-    stub_request(:get, site_url + described_class.singular_path(client, '99999', prefix)).
-                to_return(:status => 404, :body => '{"errorMessages":["'+class_basename+' Does Not Exist"],"errors": {}}')
-    expect(   lambda do
+  it 'handles a 404' do
+    stub_request(:get, site_url + described_class.singular_path(client, '99999', prefix))
+      .to_return(status: 404, body: '{"errorMessages":["' + class_basename + ' Does Not Exist"],"errors": {}}')
+    expect(lambda do
       client.send(class_basename).find('99999', options)
     end).to raise_exception(JIRA::HTTPError)
   end
 end
 
-shared_examples "a resource with a DELETE endpoint" do
-  it "deletes a resource" do
+shared_examples 'a resource with a DELETE endpoint' do
+  it 'deletes a resource' do
     # E.g., for JIRA::Resource::Project, we need to call
     # client.Project.delete()
-    stub_request(:delete, site_url + described_class.singular_path(client, key, prefix)).
-                to_return(:status => 204, :body => nil)
+    stub_request(:delete, site_url + described_class.singular_path(client, key, prefix))
+      .to_return(status: 204, body: nil)
 
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
     expect(subject.delete).to be_truthy
   end
 end
 
-shared_examples "a resource with a POST endpoint" do
-
-  it "saves a new resource" do
-    stub_request(:post, site_url + described_class.collection_path(client, prefix)).
-                to_return(:status => 201, :body => get_mock_from_path(:post))
+shared_examples 'a resource with a POST endpoint' do
+  it 'saves a new resource' do
+    stub_request(:post, site_url + described_class.collection_path(client, prefix))
+      .to_return(status: 201, body: get_mock_from_path(:post))
     subject = build_receiver.build
     expect(subject.save(attributes_for_post)).to be_truthy
     expected_attributes_from_post.each do |method_name, value|
       expect(subject.send(method_name)).to eq(value)
     end
   end
-
 end
 
-shared_examples "a resource with a PUT endpoint" do
-
-  it "saves an existing component" do
-    stub_request(:get, site_url + described_class.singular_path(client, key, prefix)).
-                to_return(:status => 200, :body => get_mock_from_path(:get, :key =>key))
-    stub_request(:put, site_url + described_class.singular_path(client, key, prefix)).
-                  to_return(:status => 200, :body => get_mock_from_path(:put, :key => key, :value_if_not_found => nil))
+shared_examples 'a resource with a PUT endpoint' do
+  it 'saves an existing component' do
+    stub_request(:get, site_url + described_class.singular_path(client, key, prefix))
+      .to_return(status: 200, body: get_mock_from_path(:get, key: key))
+    stub_request(:put, site_url + described_class.singular_path(client, key, prefix))
+      .to_return(status: 200, body: get_mock_from_path(:put, key: key, value_if_not_found: nil))
     subject = build_receiver.build(described_class.key_attribute.to_s => key)
     subject.fetch
     expect(subject.save(attributes_for_put)).to be_truthy
@@ -172,23 +158,20 @@ shared_examples "a resource with a PUT endpoint" do
       expect(subject.send(method_name)).to eq(value)
     end
   end
-
 end
 
 shared_examples 'a resource with a PUT endpoint that rejects invalid fields' do
-
-  it "fails to save with an invalid field" do
-    stub_request(:get, site_url + described_class.singular_path(client, key)).
-                to_return(:status => 200, :body => get_mock_from_path(:get, :key => key))
-    stub_request(:put, site_url + described_class.singular_path(client, key)).
-                to_return(:status => 400, :body => get_mock_from_path(:put, :key => key, :suffix => "invalid"))
+  it 'fails to save with an invalid field' do
+    stub_request(:get, site_url + described_class.singular_path(client, key))
+      .to_return(status: 200, body: get_mock_from_path(:get, key: key))
+    stub_request(:put, site_url + described_class.singular_path(client, key))
+      .to_return(status: 400, body: get_mock_from_path(:put, key: key, suffix: 'invalid'))
     subject = client.send(class_basename).build(described_class.key_attribute.to_s => key)
     subject.fetch
 
-    expect(subject.save('fields'=> {'invalid' => 'field'})).to be_falsey
+    expect(subject.save('fields' => { 'invalid' => 'field' })).to be_falsey
     expect(lambda do
-      subject.save!('fields'=> {'invalid' => 'field'})
+      subject.save!('fields' => { 'invalid' => 'field' })
     end).to raise_error(JIRA::HTTPError)
   end
-
 end