sclemmer-jira-ruby 0.1.12

data/spec/mock_responses/project/SAMPLEPROJECT.json

@@ -0,0 +1,84 @@
+{
+  "self": "http://localhost:2990/jira/rest/api/2/project/SAMPLEPROJECT",
+  "id": "10001",
+  "key": "SAMPLEPROJECT",
+  "lead": {
+    "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+    "name": "admin",
+    "avatarUrls": {
+      "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+      "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+    },
+    "displayName": "admin",
+    "active": true
+  },
+  "components": [
+    {
+      "self": "http://localhost:2990/jira/rest/api/2/component/10001",
+      "id": "10001",
+      "name": "Jamflam",
+      "isAssigneeTypeValid": false
+    },
+    {
+      "self": "http://localhost:2990/jira/rest/api/2/component/10000",
+      "id": "10000",
+      "name": "Jammy",
+      "description": "Description!",
+      "isAssigneeTypeValid": false
+    }
+  ],
+  "issueTypes": [
+    {
+      "self": "http://localhost:2990/jira/rest/api/2/issuetype/1",
+      "id": "1",
+      "description": "A problem which impairs or prevents the functions of the product.",
+      "iconUrl": "http://localhost:2990/jira/images/icons/bug.gif",
+      "name": "Bug",
+      "subtask": false
+    },
+    {
+      "self": "http://localhost:2990/jira/rest/api/2/issuetype/2",
+      "id": "2",
+      "description": "A new feature of the product, which has yet to be developed.",
+      "iconUrl": "http://localhost:2990/jira/images/icons/newfeature.gif",
+      "name": "New Feature",
+      "subtask": false
+    },
+    {
+      "self": "http://localhost:2990/jira/rest/api/2/issuetype/3",
+      "id": "3",
+      "description": "A task that needs to be done.",
+      "iconUrl": "http://localhost:2990/jira/images/icons/task.gif",
+      "name": "Task",
+      "subtask": false
+    },
+    {
+      "self": "http://localhost:2990/jira/rest/api/2/issuetype/4",
+      "id": "4",
+      "description": "An improvement or enhancement to an existing feature or task.",
+      "iconUrl": "http://localhost:2990/jira/images/icons/improvement.gif",
+      "name": "Improvement",
+      "subtask": false
+    },
+    {
+      "self": "http://localhost:2990/jira/rest/api/2/issuetype/5",
+      "id": "5",
+      "description": "The sub-task of the issue",
+      "iconUrl": "http://localhost:2990/jira/images/icons/issue_subtask.gif",
+      "name": "Sub-task",
+      "subtask": true
+    }
+  ],
+  "assigneeType": "PROJECT_LEAD",
+  "versions": [],
+  "name": "Sample Project for Developing RoR RESTful API",
+  "roles": {
+    "Users": "http://localhost:2990/jira/rest/api/2/project/SAMPLEPROJECT/role/10000",
+    "Administrators": "http://localhost:2990/jira/rest/api/2/project/SAMPLEPROJECT/role/10002",
+    "Developers": "http://localhost:2990/jira/rest/api/2/project/SAMPLEPROJECT/role/10001"
+  },
+  "avatarUrls": {
+    "16x16": "http://localhost:2990/jira/secure/projectavatar?size=small&pid=10001&avatarId=10011",
+    "48x48": "http://localhost:2990/jira/secure/projectavatar?pid=10001&avatarId=10011"
+  }
+}

data/spec/mock_responses/status.json

@@ -0,0 +1,37 @@
+[
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/status/1",
+    "description": "The issue is open and ready for the assignee to start work on it.",
+    "iconUrl": "http://localhost:2990/jira/images/icons/status_open.gif",
+    "name": "Open",
+    "id": "1"
+  },
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/status/3",
+    "description": "This issue is being actively worked on at the moment by the assignee.",
+    "iconUrl": "http://localhost:2990/jira/images/icons/status_inprogress.gif",
+    "name": "In Progress",
+    "id": "3"
+  },
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/status/4",
+    "description": "This issue was once resolved, but the resolution was deemed incorrect. From here issues are either marked assigned or resolved.",
+    "iconUrl": "http://localhost:2990/jira/images/icons/status_reopened.gif",
+    "name": "Reopened",
+    "id": "4"
+  },
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/status/5",
+    "description": "A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.",
+    "iconUrl": "http://localhost:2990/jira/images/icons/status_resolved.gif",
+    "name": "Resolved",
+    "id": "5"
+  },
+  {
+    "self": "http://localhost:2990/jira/rest/api/2/status/6",
+    "description": "The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.",
+    "iconUrl": "http://localhost:2990/jira/images/icons/status_closed.gif",
+    "name": "Closed",
+    "id": "6"
+  }
+]

data/spec/mock_responses/status/1.json

@@ -0,0 +1,7 @@
+{
+  "self": "http://localhost:2990/jira/rest/api/2/status/1",
+  "description": "The issue is open and ready for the assignee to start work on it.",
+  "iconUrl": "http://localhost:2990/jira/images/icons/status_open.gif",
+  "name": "Open",
+  "id": "1"
+}

data/spec/mock_responses/user_username=admin.json

@@ -0,0 +1,17 @@
+{
+  "self": "http://localhost:2990/jira/rest/api/2/user?username=admin",
+  "name": "admin",
+  "emailAddress": "admin@example.com",
+  "avatarUrls": {
+    "16x16": "http://localhost:2990/jira/secure/useravatar?size=small&avatarId=10122",
+    "48x48": "http://localhost:2990/jira/secure/useravatar?avatarId=10122"
+  },
+  "displayName": "admin",
+  "active": true,
+  "timeZone": "Pacific/Auckland",
+  "groups": {
+    "size": 3,
+    "items": []
+  },
+  "expand": "groups"
+}

data/spec/mock_responses/version.post.json

@@ -0,0 +1,7 @@
+{
+  "self": "http://localhost:2990/jira/rest/api/2/version/10001",
+  "id": "10001",
+  "name": "2.0",
+  "archived": false,
+  "released": false
+}

data/spec/mock_responses/version/10000.invalid.put.json

@@ -0,0 +1,5 @@
+{
+  "errorMessages": [
+    "Unrecognized field \"chump\" (Class com.atlassian.jira.rest.v2.issue.version.VersionBean), not marked as ignorable\n at [Source: org.apache.catalina.connector.CoyoteInputStream@4264a42e; line: 1, column: 2]"
+  ]
+}

data/spec/mock_responses/version/10000.json

@@ -0,0 +1,11 @@
+{
+  "self": "http://localhost:2990/jira/rest/api/2/version/10000",
+  "id": "10000",
+  "description": "Initial version",
+  "name": "1.0",
+  "overdue": false,
+  "userReleaseDate": "12/Jan/12",
+  "archived": false,
+  "releaseDate": "2012-01-12",
+  "released": false
+}

data/spec/mock_responses/version/10000.put.json

@@ -0,0 +1,7 @@
+{
+  "self": "http://localhost:2990/jira/rest/api/2/version/10000",
+  "id": "10000",
+  "name": "2.0.0",
+  "archived": false,
+  "released": false
+}

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$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 'jira'
+
+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
+end

data/spec/support/clients_helper.rb

@@ -0,0 +1,16 @@
+module ClientsHelper
+  def with_each_client
+    clients = {}
+
+    oauth_client = JIRA::Client.new({ :consumer_key => 'foo', :consumer_secret => 'bar' })
+    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 })
+    clients["http://foo:bar@localhost:2990"] = basic_client
+
+    clients.each do |site_url, client|
+      yield site_url, client
+    end
+  end
+end

data/spec/support/matchers/have_attributes.rb

@@ -0,0 +1,11 @@
+RSpec::Matchers.define :have_attributes do |expected|
+  match do |actual|
+    expected.each do |key, value|
+      expect(actual.attrs[key]).to eq(value)
+    end
+  end
+
+  failure_message do |actual|
+    "expected #{actual.attrs} to match #{expected}"
+  end
+end

data/spec/support/matchers/have_many.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :have_many do |collection, klass|
+  match do |actual|
+    expect(actual.send(collection).class).to eq(JIRA::HasManyProxy)
+    expect(actual.send(collection).length).to be > 0
+    actual.send(collection).each do |member|
+      expect(member.class).to eq(klass)
+    end
+  end
+end

data/spec/support/matchers/have_one.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :have_one do |resource, klass|
+  match do |actual|
+    expect(actual.send(resource).class).to eq(klass)
+  end
+end

data/spec/support/shared_examples/integration.rb

@@ -0,0 +1,194 @@
+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
+  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
+  get_mock_response("#{file_path}.json", value_if_not_found)
+end
+
+def class_basename
+ described_class.name.split('::').last
+end
+
+def options
+  options = {}
+  if defined? belongs_to
+    options[belongs_to.to_sym] = belongs_to
+  end
+  options
+end
+
+def prefix
+  prefix = '/'
+  if defined? belongs_to
+    prefix = belongs_to.path_component + '/'
+  end
+  prefix
+end
+
+def build_receiver
+  if defined?(belongs_to)
+    belongs_to.send(described_class.endpoint_name.pluralize.to_sym)
+  else
+    client.send(class_basename)
+  end
+end
+
+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>")
+    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))
+    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
+    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'))
+
+    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
+    # 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))
+    subject = client.send(class_basename).find(key, options)
+
+    expect(subject).to have_attributes(expected_attributes)
+  end
+
+  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))
+
+    subject = build_receiver.build(described_class.key_attribute.to_s => key)
+    subject.fetch
+
+    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
+      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
+    # 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)
+
+    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))
+    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))
+    subject = build_receiver.build(described_class.key_attribute.to_s => key)
+    subject.fetch
+    expect(subject.save(attributes_for_put)).to be_truthy
+    expected_attributes_from_put.each do |method_name, value|
+      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"))
+    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(lambda do
+      subject.save!('fields'=> {'invalid' => 'field'})
+    end).to raise_error(JIRA::HTTPError)
+  end
+
+end