jiraSOAP 0.8.5 → 0.8.6

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.8.6
+
+	* Add extra documentation about updating cascading fields (thanks Lucas)
+
 Version 0.8.5
 
 	* Add missing alias for a predicate attribute (IssueProperty#sub_task?)

data/Rakefile

@@ -52,6 +52,3 @@ end
 
 
 ### DOCUMENTATION
-
-require 'yard'
-YARD::Rake::YardocTask.new

data/docs/GettingStarted.markdown

@@ -38,3 +38,7 @@ See {file:docs/Examples.markdown} for more examples.
 To find out what APIs are available, check out the {JIRA::RemoteAPI}
 module, as well as the {JIRA::RemoteAPIAdditions} module for
 conveniences that `jiraSOAP` has added.
+
+Some of the odder behaviours of the JIRA SOAP API are not documented
+here, though an answer might be available from the
+[JIRA FAQ](http://confluence.atlassian.com/display/JIRA/Frequently+Asked+RPC+Questions+and+Known+Issues).

data/lib/jiraSOAP/api/issues.rb

@@ -37,14 +37,29 @@ module JIRA::RemoteAPI
   # to be given id values. You must use the name of the field you wish to
   # update.
   #
+  # Updating nested fields can be trickyfields
+  #
   # @example Usage With A Normal Field
-  #  summary      = JIRA::FieldValue.new 'summary', 'My new summary'
+  #
+  #   summary      = JIRA::FieldValue.new 'summary', 'My new summary'
+  #
   # @example Usage With A Custom Field
-  #  custom_field = JIRA::FieldValue.new 'customfield_10060', '123456'
+  #
+  #   custom_field = JIRA::FieldValue.new 'customfield_10060', '123456'
+  #
   # @example Setting a field to be blank/nil
-  #  description  = JIRA::FieldValue.new 'description'
+  #
+  #   description  = JIRA::FieldValue.new 'description'
+  #
   # @example Calling the method to update an issue
-  #  jira_service_instance.update_issue 'PROJECT-1', description, custom_field
+  #
+  #   jira_service_instance.update_issue 'PROJECT-1', description, custom_field
+  #
+  # @example Setting the value of a cascading select field
+  #
+  #   part1 = JIRA::FieldValue.new 'customfield_10285',   'Main Detail'
+  #   part2 = JIRA::FieldValue.new 'customfield_10285:1', 'First Subdetail'
+  #   jira_service_instance.update_issue 'PROJECT-1', part1, part2
   #
   # @param [String] issue_key
   # @param [JIRA::FieldValue] *field_values

data/lib/jiraSOAP/entities/custom_field_value.rb

@@ -9,7 +9,7 @@ class JIRA::CustomFieldValue < JIRA::DynamicEntity
   # @return [String]
   add_attribute :id, 'customfieldId', :content
 
-  # @return [String]
+  # @return [String] Used with cascading select fields
   add_attribute :key, 'key', :content
 
   # @return [Array<String>]

data/lib/jiraSOAP/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = '0.8.5'
+  VERSION = '0.8.6'
 end

metadata

@@ -1,87 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jiraSOAP
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.8.6
   prerelease: 
-  version: 0.8.5
 platform: ruby
-authors: 
+authors:
 - Mark Rada
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-07-20 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: nokogiri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70183021802840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.4.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: handsoap
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70183021802840
+- !ruby/object:Gem::Dependency
+  name: handsoap
+  requirement: &70183021802320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.1.8
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70183021802320
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70183021801840 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: redcarpet
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70183021801840
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70183021801360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.15"
+      - !ruby/object:Gem::Version
+        version: '1.15'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70183021801360
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70183021800880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.2.2
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *70183021800880
 description: Written to run fast and work on Ruby 1.9 as well as MacRuby
-email: 
+email:
 - mrada@marketcircle.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
 - ChangeLog
 - LICENSE.txt
 - .yardopts
 - docs/GettingStarted.markdown
 - docs/Examples.markdown
-files: 
+files:
 - lib/jiraSOAP/api/additions.rb
 - lib/jiraSOAP/api/attachments.rb
 - lib/jiraSOAP/api/avatars.rb
@@ -149,34 +147,33 @@ files:
 - .yardopts
 - docs/GettingStarted.markdown
 - docs/Examples.markdown
+has_rdoc: true
 homepage: http://github.com/Marketcircle/jiraSOAP
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A Ruby client for the JIRA SOAP API
-test_files: 
+test_files:
 - test/jiraSOAP_test.rb
 - test/test_helper.rb
 - Rakefile