zk-jira-ruby 2.1.5

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

data/spec/integration/component_spec.rb

@@ -0,0 +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(:expected_attributes) do
+      {
+        'self' => 'http://localhost:2990/jira/rest/api/2/component/10000',
+        'id'   => key,
+        'name' => 'Cheesecake'
+      }
+    end
+
+    let(:attributes_for_post) do
+      { 'name' => 'Test component', 'project' => 'SAMPLEPROJECT' }
+    end
+    let(:expected_attributes_from_post) do
+      { 'id' => '10001', 'name' => 'Test component' }
+    end
+
+    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

@@ -0,0 +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(:expected_attributes) do
+      {
+        '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'
+  end
+end

data/spec/integration/issue_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Issue do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { '10002' }
+
+    let(:expected_attributes) do
+      {
+        'self'   => 'http://localhost:2990/jira/rest/api/2/issue/10002',
+        'key'    => 'SAMPLEPROJECT-1',
+        'expand' => 'renderedFields,names,schema,transitions,editmeta,changelog'
+      }
+    end
+
+    let(:attributes_for_post) do
+      { 'foo' => 'bar' }
+    end
+    let(:expected_attributes_from_post) do
+      { 'id' => '10005', 'key' => 'SAMPLEPROJECT-4' }
+    end
+
+    let(:attributes_for_put) do
+      { 'foo' => 'bar' }
+    end
+    let(:expected_attributes_from_put) do
+      { 'foo' => 'bar' }
+    end
+    let(:expected_collection_length) { 11 }
+
+    it_should_behave_like 'a resource'
+    it_should_behave_like 'a resource with a singular GET endpoint'
+    describe 'GET all issues' do # JIRA::Resource::Issue.all uses the search endpoint
+      let(:client) { client }
+      let(:site_url) { site_url }
+
+      let(:expected_attributes) do
+        {
+          'id' => '10014',
+          'self' => 'http://localhost:2990/jira/rest/api/2/issue/10014',
+          'key' => 'SAMPLEPROJECT-13'
+        }
+      end
+      before(:each) do
+        stub_request(:get, site_url + '/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=0')
+          .to_return(status: 200, body: get_mock_response('issue.json'))
+
+        stub_request(:get, site_url + '/jira/rest/api/2/search?expand=transitions.fields&maxResults=1000&startAt=11')
+          .to_return(status: 200, body: get_mock_response('empty_issues.json'))
+      end
+      it_should_behave_like 'a resource with a collection GET endpoint'
+    end
+    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'
+
+    describe 'errors' do
+      before(:each) do
+        stub_request(:get,
+                     site_url + '/jira/rest/api/2/issue/10002')
+          .to_return(status: 200, body: get_mock_response('issue/10002.json'))
+        stub_request(:put, site_url + '/jira/rest/api/2/issue/10002')
+          .with(body: '{"missing":"fields and update"}')
+          .to_return(status: 400, body: get_mock_response('issue/10002.put.missing_field_update.json'))
+      end
+
+      it 'fails to save when fields and update are missing' do
+        subject = client.Issue.build('id' => '10002')
+        subject.fetch
+        expect(subject.save('missing' => 'fields and update')).to be_falsey
+      end
+    end
+
+    describe 'GET jql issues' do # JIRA::Resource::Issue.jql uses the search endpoint
+      jql_query_string = "PROJECT = 'SAMPLEPROJECT'"
+      let(:client) { client }
+      let(:site_url) { site_url }
+      let(:jql_query_string) { jql_query_string }
+
+      let(:expected_attributes) do
+        {
+          'id' => '10014',
+          'self' => 'http://localhost:2990/jira/rest/api/2/issue/10014',
+          'key' => 'SAMPLEPROJECT-13'
+        }
+      end
+      it_should_behave_like 'a resource with JQL inputs and a collection GET endpoint'
+    end
+  end
+end

data/spec/integration/issuelinktype_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Issuelinktype do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { '10000' }
+
+    let(:expected_attributes) do
+      {
+        'id' => key,
+        'self' => 'http://localhost:2990/jira/rest/api/2/issueLinkType/10000',
+        'name' => 'Blocks',
+        'inward' => 'is blocked by',
+        'outward' => 'blocks'
+      }
+    end
+
+    let(:expected_collection_length) { 3 }
+
+    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

data/spec/integration/issuetype_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Issuetype do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { '5' }
+
+    let(:expected_attributes) do
+      {
+        'self' => 'http://localhost:2990/jira/rest/api/2/issuetype/5',
+        'id' => key,
+        'name' => 'Sub-task'
+      }
+    end
+
+    let(:expected_collection_length) { 5 }
+
+    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

data/spec/integration/priority_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Priority do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { '1' }
+
+    let(:expected_attributes) do
+      {
+        'self' => 'http://localhost:2990/jira/rest/api/2/priority/1',
+        'id' => key,
+        'name' => 'Blocker'
+      }
+    end
+
+    let(:expected_collection_length) { 5 }
+
+    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

data/spec/integration/project_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Project do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { 'SAMPLEPROJECT' }
+
+    let(:expected_attributes) do
+      {
+        'self'   => 'http://localhost:2990/jira/rest/api/2/project/SAMPLEPROJECT',
+        'key'    => key,
+        'name'   => 'Sample Project for Developing RoR RESTful API'
+      }
+    end
+
+    let(:expected_collection_length) { 1 }
+
+    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'
+
+    describe 'issues' do
+      it 'returns all the issues' do
+        stub_request(:get, site_url + '/jira/rest/api/2/search?jql=project="SAMPLEPROJECT"')
+          .to_return(status: 200, body: get_mock_response('project/SAMPLEPROJECT.issues.json'))
+        subject = client.Project.build('key' => key)
+        issues = subject.issues
+        expect(issues.length).to eq(11)
+        issues.each do |issue|
+          expect(issue.class).to eq(JIRA::Resource::Issue)
+          expect(issue.expanded?).to be_falsey
+        end
+      end
+    end
+
+    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('project/SAMPLEPROJECT.json'))
+
+      subject = client.Project.find(key)
+      expect(subject.components.length).to eq(2)
+      subject.components.each do |component|
+        expect(component.class).to eq(JIRA::Resource::Component)
+      end
+    end
+  end
+end

data/spec/integration/rapidview_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe JIRA::Resource::RapidView do
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+    let(:key) { '1' }
+
+    let(:expected_collection_length) { 1 }
+
+    let(:expected_attributes) do
+      {
+        'id' => 1,
+        'name' => 'SAMPLEPROJECT',
+        'canEdit' => true,
+        'sprintSupportEnabled' => true
+      }
+    end
+
+    it_should_behave_like 'a resource'
+    # TODO@Anton: Add json file
+    # it_should_behave_like 'a resource with a singular GET endpoint'
+
+    describe 'GET all rapidviews' do
+      let(:client) { client }
+      let(:site_url) { site_url }
+
+      before(:each) do
+        stub_request(:get, site_url + '/jira/rest/greenhopper/1.0/rapidview')
+          .to_return(status: 200, body: get_mock_response('rapidview.json'))
+      end
+      it_should_behave_like 'a resource with a collection GET endpoint'
+    end
+
+    describe 'issues' do
+      it 'should return all the issues' do
+        stub_request(
+          :get,
+          site_url +
+          '/jira/rest/greenhopper/1.0/xboard/plan/backlog/data?rapidViewId=1'
+        ).to_return(
+          status: 200,
+          body: get_mock_response('rapidview/SAMPLEPROJECT.issues.json')
+        )
+
+        stub_request(
+          :get,
+          site_url + '/jira/rest/api/2/search?jql=id IN(10001, 10000)'
+        ).to_return(
+          status: 200,
+          body: get_mock_response('rapidview/SAMPLEPROJECT.issues.full.json')
+        )
+
+        stub_request(
+          :get,
+          site_url + '/jira/rest/api/2/search?jql=id IN(10000, 10001) AND sprint IS NOT EMPTY'
+        ).to_return(
+          status: 200,
+          body: get_mock_response('rapidview/SAMPLEPROJECT.issues.full.json')
+        )
+
+        subject = client.RapidView.build('id' => 1)
+        issues = subject.issues
+        expect(issues.length).to eq(2)
+
+        issues.each do |issue|
+          expect(issue.class).to eq(JIRA::Resource::Issue)
+          expect(issue.expanded?).to be_falsey
+        end
+      end
+    end
+  end
+end