jira-ruby 0.0.2 → 0.0.3

data/spec/mock_responses/project/SAMPLEPROJECT.json

@@ -12,7 +12,21 @@
     "displayName": "admin",
     "active": true
   },
-  "components": [],
+  "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",

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

@@ -2,6 +2,7 @@ $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'
 
@@ -9,18 +10,12 @@ RSpec.configure do |config|
 
 end
 
-RSpec::Matchers.define :have_attributes do |expected|
-  match do |actual|
-    expected.each do |key, value|
-      actual.attrs[key].should == value
-    end
-  end
 
-  failure_message_for_should do |actual|
-    "expected #{actual.attrs} to match #{expected}"
+def get_mock_response(file, value_if_file_not_found = false)
+  begin
+    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
-
-def get_mock_response(file)
-  File.read(File.join(File.dirname(__FILE__), 'mock_responses/', file))
-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|
+      actual.attrs[key].should == value
+    end
+  end
+
+  failure_message_for_should 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|
+    actual.send(collection).class.should == JIRA::HasManyProxy
+    actual.send(collection).length.should > 0
+    actual.send(collection).each do |member|
+      member.class.should == 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|
+    actual.send(resource).class.should == klass
+  end
+end

data/spec/support/shared_examples/integration.rb

@@ -0,0 +1,174 @@
+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, 'http://localhost:2990' + subject.url).
+                to_return(:status => 405, :body => "<html><body>Some HTML</body></html>")
+    subject.save('foo' => 'bar').should be_false
+    lambda do
+      subject.save!('foo' => 'bar').should be_false
+    end.should 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, "http://localhost:2990" + described_class.collection_path(client)).
+                 to_return(:status => 200, :body => get_mock_from_path(:get))
+    collection = build_receiver.all
+    collection.length.should == expected_collection_length
+
+    first = collection.first
+    first.should 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, "http://localhost:2990" + 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)
+
+    subject.should 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, "http://localhost:2990" + 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
+
+    subject.should have_attributes(expected_attributes)
+  end
+
+  it "handles a 404" do
+    stub_request(:get, "http://localhost:2990" + described_class.singular_path(client, '99999', prefix)).
+                to_return(:status => 404, :body => '{"errorMessages":["'+class_basename+' Does Not Exist"],"errors": {}}')
+    lambda do
+      client.send(class_basename).find('99999', options)
+    end.should 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, "http://localhost:2990" + described_class.singular_path(client, key, prefix)).
+                to_return(:status => 204, :body => nil)
+
+    subject = build_receiver.build(described_class.key_attribute.to_s => key)
+    subject.delete.should be_true
+  end
+end
+
+shared_examples "a resource with a POST endpoint" do
+
+  it "saves a new resource" do
+    stub_request(:post, "http://localhost:2990" + described_class.collection_path(client, prefix)).
+                to_return(:status => 201, :body => get_mock_from_path(:post))
+    subject = build_receiver.build
+    subject.save(attributes_for_post).should be_true
+    expected_attributes_from_post.each do |method_name, value|
+      subject.send(method_name).should == value
+    end
+  end
+
+end
+
+shared_examples "a resource with a PUT endpoint" do
+
+  it "saves an existing component" do
+    stub_request(:get, "http://localhost:2990" + described_class.singular_path(client, key, prefix)).
+                to_return(:status => 200, :body => get_mock_from_path(:get, :key =>key))
+    stub_request(:put, "http://localhost:2990" + 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
+    subject.save(attributes_for_put).should be_true
+    expected_attributes_from_put.each do |method_name, value|
+      subject.send(method_name).should == 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, "http://localhost:2990" + described_class.singular_path(client, key)).
+                to_return(:status => 200, :body => get_mock_from_path(:get, :key => key))
+    stub_request(:put, "http://localhost:2990" + 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
+
+    subject.save('fields'=> {'invalid' => 'field'}).should be_false
+    lambda do
+      subject.save!('fields'=> {'invalid' => 'field'})
+    end.should raise_error(JIRA::HTTPError)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000Z
+date: 2012-01-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70116927294340 !ruby/object:Gem::Requirement
+  requirement: &70202332043180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70116927294340
+  version_requirements: *70202332043180
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70116927293920 !ruby/object:Gem::Requirement
+  requirement: &70202332042760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70116927293920
+  version_requirements: *70202332042760
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70116927293500 !ruby/object:Gem::Requirement
+  requirement: &70202332042340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70116927293500
+  version_requirements: *70202332042340
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &70116927321980 !ruby/object:Gem::Requirement
+  requirement: &70202332041920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70116927321980
+  version_requirements: *70202332041920
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70202332041500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70202332041500
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70202332041080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70202332041080
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70116927321560 !ruby/object:Gem::Requirement
+  requirement: &70202332040660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,8 +87,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70116927321560
-description: API for Jira 5
+  version_requirements: *70202332040660
+description: API for JIRA 5
 email: 
 executables: []
 extensions: []
@@ -74,37 +96,88 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README.markdown
+- README.rdoc
 - Rakefile
 - example.rb
 - jira-ruby.gemspec
 - lib/jira.rb
+- lib/jira/base.rb
+- lib/jira/base_factory.rb
 - lib/jira/client.rb
-- lib/jira/resource/base.rb
-- lib/jira/resource/base_factory.rb
+- lib/jira/has_many_proxy.rb
+- lib/jira/http_error.rb
+- lib/jira/resource/attachment.rb
+- lib/jira/resource/comment.rb
 - lib/jira/resource/component.rb
-- lib/jira/resource/http_error.rb
 - lib/jira/resource/issue.rb
+- lib/jira/resource/issuetype.rb
+- lib/jira/resource/priority.rb
 - lib/jira/resource/project.rb
+- lib/jira/resource/status.rb
+- lib/jira/resource/user.rb
+- lib/jira/resource/version.rb
+- lib/jira/resource/worklog.rb
 - lib/jira/tasks.rb
 - lib/jira/version.rb
 - lib/tasks/generate.rake
+- spec/integration/attachment_spec.rb
+- spec/integration/comment_spec.rb
 - spec/integration/component_spec.rb
 - spec/integration/issue_spec.rb
+- spec/integration/issuetype_spec.rb
+- spec/integration/priority_spec.rb
 - spec/integration/project_spec.rb
+- spec/integration/status_spec.rb
+- spec/integration/user_spec.rb
+- spec/integration/version_spec.rb
+- spec/integration/worklog_spec.rb
+- spec/jira/base_factory_spec.rb
+- spec/jira/base_spec.rb
 - spec/jira/client_spec.rb
-- spec/jira/resource/base_factory_spec.rb
-- spec/jira/resource/base_spec.rb
-- spec/jira/resource/http_error_spec.rb
+- spec/jira/has_many_proxy_spec.rb
+- spec/jira/http_error_spec.rb
+- spec/jira/resource/attachment_spec.rb
+- spec/jira/resource/issue_spec.rb
 - spec/jira/resource/project_factory_spec.rb
+- spec/jira/resource/project_spec.rb
+- spec/jira/resource/worklog_spec.rb
+- spec/mock_responses/attachment/10000.json
 - spec/mock_responses/component.post.json
+- spec/mock_responses/component/10000.invalid.put.json
 - spec/mock_responses/component/10000.json
 - spec/mock_responses/component/10000.put.json
+- spec/mock_responses/issue.json
 - spec/mock_responses/issue.post.json
+- spec/mock_responses/issue/10002.invalid.put.json
 - spec/mock_responses/issue/10002.json
+- spec/mock_responses/issue/10002.put.missing_field_update.json
+- spec/mock_responses/issue/10002/comment.json
+- spec/mock_responses/issue/10002/comment.post.json
+- spec/mock_responses/issue/10002/comment/10000.json
+- spec/mock_responses/issue/10002/comment/10000.put.json
+- spec/mock_responses/issue/10002/worklog.json
+- spec/mock_responses/issue/10002/worklog.post.json
+- spec/mock_responses/issue/10002/worklog/10000.json
+- spec/mock_responses/issue/10002/worklog/10000.put.json
+- spec/mock_responses/issuetype.json
+- spec/mock_responses/issuetype/5.json
+- spec/mock_responses/priority.json
+- spec/mock_responses/priority/1.json
 - spec/mock_responses/project.json
+- spec/mock_responses/project/SAMPLEPROJECT.issues.json
 - spec/mock_responses/project/SAMPLEPROJECT.json
+- spec/mock_responses/status.json
+- spec/mock_responses/status/1.json
+- spec/mock_responses/user?username=admin.json
+- spec/mock_responses/version.post.json
+- spec/mock_responses/version/10000.invalid.put.json
+- spec/mock_responses/version/10000.json
+- spec/mock_responses/version/10000.put.json
 - spec/spec_helper.rb
+- spec/support/matchers/have_attributes.rb
+- spec/support/matchers/have_many.rb
+- spec/support/matchers/have_one.rb
+- spec/support/shared_examples/integration.rb
 homepage: http://trineo.co.nz
 licenses: []
 post_install_message: 
@@ -128,21 +201,63 @@ rubyforge_project: jira-ruby
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Ruby Gem for use with the Atlassian Jira 5 REST API
+summary: Ruby Gem for use with the Atlassian JIRA 5 REST API
 test_files:
+- spec/integration/attachment_spec.rb
+- spec/integration/comment_spec.rb
 - spec/integration/component_spec.rb
 - spec/integration/issue_spec.rb
+- spec/integration/issuetype_spec.rb
+- spec/integration/priority_spec.rb
 - spec/integration/project_spec.rb
+- spec/integration/status_spec.rb
+- spec/integration/user_spec.rb
+- spec/integration/version_spec.rb
+- spec/integration/worklog_spec.rb
+- spec/jira/base_factory_spec.rb
+- spec/jira/base_spec.rb
 - spec/jira/client_spec.rb
-- spec/jira/resource/base_factory_spec.rb
-- spec/jira/resource/base_spec.rb
-- spec/jira/resource/http_error_spec.rb
+- spec/jira/has_many_proxy_spec.rb
+- spec/jira/http_error_spec.rb
+- spec/jira/resource/attachment_spec.rb
+- spec/jira/resource/issue_spec.rb
 - spec/jira/resource/project_factory_spec.rb
+- spec/jira/resource/project_spec.rb
+- spec/jira/resource/worklog_spec.rb
+- spec/mock_responses/attachment/10000.json
 - spec/mock_responses/component.post.json
+- spec/mock_responses/component/10000.invalid.put.json
 - spec/mock_responses/component/10000.json
 - spec/mock_responses/component/10000.put.json
+- spec/mock_responses/issue.json
 - spec/mock_responses/issue.post.json
+- spec/mock_responses/issue/10002.invalid.put.json
 - spec/mock_responses/issue/10002.json
+- spec/mock_responses/issue/10002.put.missing_field_update.json
+- spec/mock_responses/issue/10002/comment.json
+- spec/mock_responses/issue/10002/comment.post.json
+- spec/mock_responses/issue/10002/comment/10000.json
+- spec/mock_responses/issue/10002/comment/10000.put.json
+- spec/mock_responses/issue/10002/worklog.json
+- spec/mock_responses/issue/10002/worklog.post.json
+- spec/mock_responses/issue/10002/worklog/10000.json
+- spec/mock_responses/issue/10002/worklog/10000.put.json
+- spec/mock_responses/issuetype.json
+- spec/mock_responses/issuetype/5.json
+- spec/mock_responses/priority.json
+- spec/mock_responses/priority/1.json
 - spec/mock_responses/project.json
+- spec/mock_responses/project/SAMPLEPROJECT.issues.json
 - spec/mock_responses/project/SAMPLEPROJECT.json
+- spec/mock_responses/status.json
+- spec/mock_responses/status/1.json
+- spec/mock_responses/user?username=admin.json
+- spec/mock_responses/version.post.json
+- spec/mock_responses/version/10000.invalid.put.json
+- spec/mock_responses/version/10000.json
+- spec/mock_responses/version/10000.put.json
 - spec/spec_helper.rb
+- spec/support/matchers/have_attributes.rb
+- spec/support/matchers/have_many.rb
+- spec/support/matchers/have_one.rb
+- spec/support/shared_examples/integration.rb