jiraSOAP 0.8.6 → 0.9.0

data/ChangeLog

@@ -1,6 +1,16 @@
+Version 0.9.0
+
+	* Deprecate RemoteAPI#get_projects_without_schemes in favour of #projects
+	* Properly deprecate #get_ methods
+	* Add RemoteAPI#progress_workflow_action (thanks Lucas Jourdes)
+	* Add RemoteAPI#available_action (thanks Lucas Jourdes)
+	* Add extra documentation about updating fields (thanks Vincent Beau)
+
+	* Various small documentation updates and tweaks
+
 Version 0.8.6
 
-	* Add extra documentation about updating cascading fields (thanks Lucas)
+	* Add extra documentation about updating cascading fields (thanks Lucas Jourdes)
 
 Version 0.8.5
 

data/Rakefile

@@ -22,11 +22,8 @@ end
 ### GEM STUFF
 
 require 'rake/gempackagetask'
-spec = Gem::Specification.load('jiraSOAP.gemspec')
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = false
-  pkg.need_tar = true
-end
+spec = Gem::Specification.load 'jiraSOAP.gemspec'
+Rake::GemPackageTask.new(spec) { }
 
 require 'rubygems/dependency_installer'
 desc 'Build the gem and install it'
@@ -41,7 +38,7 @@ require 'rake/testtask'
 Rake::TestTask.new(:test) do |t|
   t.libs     << 'test'
   t.pattern   = 'test/**/test_*.rb'
-  t.ruby_opts = ['-rhelper']
+  t.ruby_opts = ['-rhelper.rb']
   t.verbose   = true
 end
 
@@ -52,3 +49,10 @@ end
 
 
 ### DOCUMENTATION
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError => e
+  warn 'yard not available. Install it with: gem install yard'
+end

data/docs/Examples.markdown

@@ -86,7 +86,22 @@ documentation as well ({JIRA::RemoteAPI#update_issue}).
 
     summary = JIRA::FieldValue.new('summary', 'new summary info from jiraSOAP')
     jira.update_issue issue.key, summary
-    puts "Updated issue #{issue.key}'s field #{summary.name}\n"
+    puts "Updated issue #{issue.key}'s field #{summary.field_name}\n"
+
+One caveat is that some fields cannot be updated without also
+progressing the issue to a new status.
+
+    action = jira.available_actions('TST-14').find do |action|
+      action.name == 'Send To Test'
+    end
+
+    jira.progress_workflow_action 'TST-14', action.id
+
+You can also update fields, when progressing an issue to a new
+workflow state.
+
+    assignee = JIRA::FieldValue.new 'assignee', 'mrada'
+    jira.progress_workflow_action 'TST-14', action.id, assignee
 
 ## User Information
 

data/lib/jiraSOAP.rb

@@ -13,10 +13,32 @@ require 'jiraSOAP/macruby_extensions' if RUBY_ENGINE == 'macruby'
 
 ##
 # All the remote entities as well as the SOAP service client.
-module JIRA
+module JIRA; end
+
+##
+# Inspired by Gem::Deprecate from rubygems. A mixin that exposes a
+# method to declare deprecated methods.
+module JIRA::Deprecate
+
+  ##
+  # Deprecate a method that begins with `get_` by printing out a
+  # message and then calling the original method.
+  #
+  # @param [Symbol] name
+  def deprecate name
+    define_method "get_#{name}" do |*args|
+      $stderr.puts <<-EOM
+RemoteAPI#get_#{name} is deprecated and will be removed in the next release.
+Please use RemoteAPI#{name} instead.
+      EOM
+      send name, *args
+    end
+  end
+
 end
 
 require 'jiraSOAP/version'
+require 'jiraSOAP/core_extensions'
 require 'jiraSOAP/entities'
 require 'jiraSOAP/api'
 require 'jiraSOAP/jira_service'

data/lib/jiraSOAP/api.rb

@@ -1,28 +1,12 @@
-require 'jiraSOAP/api/additions'
-require 'jiraSOAP/api/attachments'
-require 'jiraSOAP/api/avatars'
-require 'jiraSOAP/api/comments'
-require 'jiraSOAP/api/filters'
-require 'jiraSOAP/api/issue_data_types'
-require 'jiraSOAP/api/issues'
-require 'jiraSOAP/api/project_roles'
-require 'jiraSOAP/api/projects'
-require 'jiraSOAP/api/schemes'
-require 'jiraSOAP/api/server_info'
-require 'jiraSOAP/api/users'
-require 'jiraSOAP/api/versions'
-require 'jiraSOAP/api/worklog'
-
 ##
-# @todo progressWorkflowAction and friends
-# @todo monkey patch Array to include a #to_soap method
-#
 # Contains the API defined by Atlassian for the [JIRA SOAP service](http://docs.atlassian.com/software/jira/docs/api/rpc-jira-plugin/latest/com/atlassian/jira/rpc/soap/JiraSoapService.html).
 #
 # There are several cases where this API diverges from the one defined by
 # Atlassian; most notably, this API tries to be more idomatically Ruby by using
 # snake case for method names, default values, varargs, etc..
 module JIRA::RemoteAPI
+  extend JIRA::Deprecate
+
 
   # @group Logging in/out
 
@@ -59,7 +43,6 @@ module JIRA::RemoteAPI
 
   ##
   # @todo make this method less ugly
-  # @todo handle arrays of strings
   #
   # A generic method for calling a SOAP method and soapifying all
   # the arguments.
@@ -72,8 +55,8 @@ module JIRA::RemoteAPI
     invoke "soap:#{method}" do |msg|
       for i in 0...args.size
         case arg = args.shift
-        when JIRA::Entity
-          msg.add "soap:in#{i}", do |submsg| arg.soapify_for submsg end
+        when JIRA::Entity, Array
+          msg.add "soap:in#{i}" do |submsg| arg.soapify_for submsg end
         else
           msg.add "soap:in#{i}", arg
         end
@@ -99,7 +82,7 @@ module JIRA::RemoteAPI
   end
 
   ##
-  # A more complex form of {#call} that does a little more work for
+  # A more complex form of {#jira_call} that does a little more work for
   # you when you need to build an array of return values.
   #
   # @param [String] method name of the JIRA SOAP API method
@@ -108,7 +91,23 @@ module JIRA::RemoteAPI
   # @return [Nokogiri::XML::NodeSet]
   def array_jira_call type, method, *args
     response = soap_call method, self.auth_token, *args
-    response.xpath("node()").map { |frag| type.new_with_xml(frag) }
+    response.xpath('node()').map { |frag| type.new_with_xml(frag) }
   end
 
 end
+
+
+require 'jiraSOAP/api/additions'
+require 'jiraSOAP/api/attachments'
+require 'jiraSOAP/api/avatars'
+require 'jiraSOAP/api/comments'
+require 'jiraSOAP/api/filters'
+require 'jiraSOAP/api/issue_data_types'
+require 'jiraSOAP/api/issues'
+require 'jiraSOAP/api/project_roles'
+require 'jiraSOAP/api/projects'
+require 'jiraSOAP/api/schemes'
+require 'jiraSOAP/api/server_info'
+require 'jiraSOAP/api/users'
+require 'jiraSOAP/api/versions'
+require 'jiraSOAP/api/worklog'

data/lib/jiraSOAP/api/additions.rb

@@ -3,6 +3,7 @@
 # SOAP API javadoc. They are generally close to something from the javadoc
 # but with some extra conveniences.
 module JIRA::RemoteAPIAdditions
+  extend JIRA::Deprecate
 
   ##
   # Returns the first field that exactly matches the given
@@ -11,11 +12,8 @@ module JIRA::RemoteAPIAdditions
   # @param [String] name
   # @return [JIRA::Field,nil]
   def custom_field_with_name name
-    get_custom_fields.each { |cf|
-      return cf if cf.name == name
-    }
-    nil
+    get_custom_fields.find { |cf| cf.name == name }
   end
-  alias_method :get_custom_field_with_name, :custom_field_with_name
+  deprecate :custom_field_with_name
 
 end

data/lib/jiraSOAP/api/attachments.rb

@@ -17,7 +17,7 @@ module JIRA::RemoteAPI
   def attachments_for_issue_with_key issue_key
     array_jira_call JIRA::AttachmentMetadata, 'getAttachmentsFromIssue', issue_key
   end
-  alias_method :get_attachments_for_issue_with_key, :attachments_for_issue_with_key
+  deprecate :attachments_for_issue_with_key
 
   ##
   # Expect this method to be slow.
@@ -27,16 +27,7 @@ module JIRA::RemoteAPI
   # @param [Array<String>] data base64 encoded data
   # @return [Boolean] true if successful
   def add_base64_encoded_attachments_to_issue_with_key issue_key, filenames, data
-    invoke('soap:addBase64EncodedAttachmentsToIssue') { |msg|
-      msg.add 'soap:in0', self.auth_token
-      msg.add 'soap:in1', issue_key
-      msg.add 'soap:in2' do |submsg|
-        filenames.each { |filename| submsg.add 'filenames', filename }
-      end
-      msg.add 'soap:in3' do |submsg|
-        data.each { |datum| submsg.add 'base64EncodedData', datum }
-      end
-    }
+    jira_call 'addBase64EncodedAttachmentsToIssue', issue_key, filenames, data
     true
   end
 

data/lib/jiraSOAP/api/avatars.rb

@@ -4,18 +4,18 @@ module JIRA::RemoteAPI
 
   ##
   # Gets you the default avatar image for a project; if you want all
-  # the avatars for a project, use {#get_project_avatars_for_key}.
+  # the avatars for a project, use {#project_avatars_for_key}.
   #
   # @param [String] project_key
   # @return [JIRA::Avatar]
   def project_avatar_for_key project_key
-    JIRA::Avatar.new_with_xml jira_call( 'getProjectAvatar', project_key )
+    JIRA::Avatar.new_with_xml jira_call('getProjectAvatar', project_key)
   end
-  alias_method :get_project_avatar_for_key, :project_avatar_for_key
+  deprecate :project_avatar_for_key
 
   ##
   # Gets ALL avatars for a given project with this method; if you
-  # just want the project avatar, use {#get_project_avatar_for_key}.
+  # just want the project avatar, use {#project_avatar_for_key}.
   #
   # @param [String] project_key
   # @param [Boolean] include_default_avatars
@@ -23,7 +23,7 @@ module JIRA::RemoteAPI
   def project_avatars_for_key project_key, include_default_avatars = false
     array_jira_call JIRA::Avatar, 'getProjectAvatars', project_key, include_default_avatars
   end
-  alias_method :get_project_avatars_for_key, :project_avatars_for_key
+  deprecate :project_avatars_for_key
 
   ##
   # @note You cannot delete system avatars, and you need project

data/lib/jiraSOAP/api/comments.rb

@@ -15,14 +15,14 @@ module JIRA::RemoteAPI
   def comment_with_id id
     JIRA::Comment.new_with_xml jira_call( 'getComment', id )
   end
-  alias_method :get_comment_with_id, :comment_with_id
+  deprecate :comment_with_id
 
   # @param [String] issue_key
   # @return [Array<JIRA::Comment>]
   def comments_for_issue_with_key issue_key
     array_jira_call JIRA::Comment, 'getComments', issue_key
   end
-  alias_method :get_comments_for_issue_with_key, :comments_for_issue_with_key
+  deprecate :comments_for_issue_with_key
 
   # @param [JIRA::Comment] comment
   # @return [JIRA::Comment]

data/lib/jiraSOAP/api/filters.rb

@@ -9,15 +9,15 @@ module JIRA::RemoteAPI
   def favourite_filters
     array_jira_call JIRA::Filter, 'getFavouriteFilters'
   end
-  alias_method :get_favourite_filters, :favourite_filters
-  alias_method :get_favorite_filters,  :favourite_filters
   alias_method :favorite_filters,      :favourite_filters
+  deprecate :favorite_filters
+  deprecate :favourite_filters
 
   # @param [String] id
   # @return [Fixnum]
   def issue_count_for_filter_with_id id
     jira_call( 'getIssueCountForFilter', id ).to_i
   end
-  alias_method :get_issue_count_for_filter_with_id, :issue_count_for_filter_with_id
+  deprecate :issue_count_for_filter_with_id
 
 end

data/lib/jiraSOAP/api/issue_data_types.rb

@@ -6,51 +6,51 @@ module JIRA::RemoteAPI
   def priorities
     array_jira_call JIRA::Priority, 'getPriorities'
   end
-  alias_method :get_priorities, :priorities
+  deprecate :priorities
 
   # @return [Array<JIRA::Resolution>]
   def resolutions
     array_jira_call JIRA::Resolution, 'getResolutions'
   end
-  alias_method :get_resolutions, :resolutions
+  deprecate :resolutions
 
   # @return [Array<JIRA::Field>]
   def custom_fields
     array_jira_call JIRA::Field, 'getCustomFields'
   end
-  alias_method :get_custom_fields, :custom_fields
+  deprecate :custom_fields
 
   # @return [Array<JIRA::IssueType>]
   def issue_types
     array_jira_call JIRA::IssueType, 'getIssueTypes'
   end
-  alias_method :get_issue_types, :issue_types
+  deprecate :issue_types
 
   # @param [String] project_name
   # @return [Array<JIRA::IssueType>]
   def issue_types_for_project_with_id project_id
     array_jira_call JIRA::IssueType, 'getIssueTypesForProject', project_id
   end
-  alias_method :get_issue_types_for_project_with_id, :issue_types_for_project_with_id
+  deprecate :issue_types_for_project_with_id
 
   # @return [Array<JIRA::Status>]
   def statuses
     array_jira_call JIRA::Status, 'getStatuses'
   end
-  alias_method :get_statuses, :statuses
+  deprecate :statuses
 
   # @return [Array<JIRA::IssueType>]
   def subtask_issue_types
     array_jira_call JIRA::IssueType, 'getSubTaskIssueTypes'
   end
-  alias_method :get_subtask_issue_types, :subtask_issue_types
+  deprecate :subtask_issue_types
 
   # @param [String] project_id
   # @return [Array<JIRA::IssueType>]
   def subtask_issue_types_for_project_with_id project_id
     array_jira_call JIRA::IssueType, 'getSubTaskIssueTypesForProject', project_id
   end
-  alias_method :get_subtask_issue_types_for_project_with_id, :subtask_issue_types_for_project_with_id
+  deprecate :subtask_issue_types_for_project_with_id
 
   ##
   # @todo find out what this method does

data/lib/jiraSOAP/api/issues.rb

@@ -20,7 +20,7 @@ module JIRA::RemoteAPI
   def issues_from_jql_search jql_query, max_results = 2000
     array_jira_call JIRA::Issue, 'getIssuesFromJqlSearch', jql_query, max_results
   end
-  alias_method :get_issues_from_jql_search, :issues_from_jql_search
+  deprecate :issues_from_jql_search
 
   ##
   # This method can update most, but not all, issue fields. Some limitations
@@ -34,10 +34,21 @@ module JIRA::RemoteAPI
   #  - attachments - use {#add_base64_encoded_attachments_to_issue_with_key}
   #
   # Though {JIRA::FieldValue} objects have an id field, they do not expect
-  # to be given id values. You must use the name of the field you wish to
-  # update.
+  # to be given id values. You must use the camel cased name of the field you
+  # wish to update, such as `'fixVersions'` to update the `fix_versions` for
+  # an issue.
   #
-  # Updating nested fields can be trickyfields
+  # However, there is at least one exception to the rule; when you wish to
+  # update the affected versions for an issue, you should use `'versions'`
+  # instead of `'affectsVersions'`. You need to be careful about these
+  # cases as it has been reported that JIRA will silently fail to update
+  # fields it does not know about.
+  #
+  # Updating nested fields can be tricky, see the example on cascading
+  # select field's to see how it would be done.
+  #
+  # A final note, some fields only should be passed the id in order to
+  # update them, as shown in the version updating example.
   #
   # @example Usage With A Normal Field
   #
@@ -53,26 +64,25 @@ module JIRA::RemoteAPI
   #
   # @example Calling the method to update an issue
   #
-  #   jira_service_instance.update_issue 'PROJECT-1', description, custom_field
+  #   jira.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
+  #   jira.update_issue 'PROJECT-1', part1, part2
+  #
+  # @example Changing the affected versions for an issue
+  #
+  #   version = jira.versions_for_project.find { |x| x.name = 'v1.0beta' }
+  #   field   = JIRA::FieldValue.new 'versions', version.id
+  #   jira.update_issue 'PROJECT-1', field
   #
   # @param [String] issue_key
   # @param [JIRA::FieldValue] *field_values
   # @return [JIRA::Issue]
   def update_issue issue_key, *field_values
-    response = invoke('soap:updateIssue') { |msg|
-      msg.add 'soap:in0', self.auth_token
-      msg.add 'soap:in1', issue_key
-      msg.add 'soap:in2' do |submsg|
-        field_values.each { |fv| fv.soapify_for submsg }
-      end
-    }
-    JIRA::Issue.new_with_xml response.document.element.xpath('//updateIssueReturn').first
+    JIRA::Issue.new_with_xml jira_call('updateIssue', issue_key, field_values)
   end
 
   ##
@@ -97,14 +107,14 @@ module JIRA::RemoteAPI
   def issue_with_key issue_key
     JIRA::Issue.new_with_xml jira_call( 'getIssue', issue_key )
   end
-  alias_method :get_issue_with_key, :issue_with_key
+  deprecate :issue_with_key
 
   # @param [String] issue_id
   # @return [JIRA::Issue]
   def issue_with_id issue_id
     JIRA::Issue.new_with_xml jira_call( 'getIssueById', issue_id )
   end
-  alias_method :get_issue_with_id, :issue_with_id
+  deprecate :issue_with_id
 
   # @param [String] id
   # @param [Fixnum] max_results
@@ -113,20 +123,47 @@ module JIRA::RemoteAPI
   def issues_from_filter_with_id id, max_results = 500, offset = 0
     array_jira_call JIRA::Issue, 'getIssuesFromFilterWithLimit', id, offset, max_results
   end
-  alias_method :get_issues_from_filter_with_id, :issues_from_filter_with_id
+  deprecate :issues_from_filter_with_id
 
   # @param [String] issue_id
   # @return [Time]
   def resolution_date_for_issue_with_id issue_id
     jira_call( 'getResolutionDateById', issue_id ).to_iso_date
   end
-  alias_method :get_resolution_date_for_issue_with_id, :resolution_date_for_issue_with_id
+  deprecate :resolution_date_for_issue_with_id
 
   # @param [String] issue_key
   # @return [Time]
   def resolution_date_for_issue_with_key issue_key
     jira_call( 'getResolutionDateByKey', issue_key ).to_iso_date
   end
-  alias_method :get_resolution_date_for_issue_with_key, :resolution_date_for_issue_with_key
+  deprecate :resolution_date_for_issue_with_key
+
+  ##
+  # This method acts like {#update_issue} except that it also updates
+  # the status of the issue.
+  #
+  # The `action_id` parameter comes from the `id` of an available action.
+  # Normally you will use this method in conjunction with
+  # {#available_actions} to decide which action to take.
+  #
+  # @param [String] issue_key
+  # @param [String] action_id this is the id of workflow action
+  # @param [JIRA::FieldValue] *field_values
+  # @return [JIRA::Issue]
+  def progress_workflow_action issue_key, action_id, *field_values
+    JIRA::Issue.new_with_xml jira_call('progressWorkflowAction',
+                                       issue_key, action_id_string, field_values)
+  end
+
+  ##
+  # Returns workflow actions available for an issue.
+  #
+  # @param [String] issue_key
+  # @return [Array<JIRA::NamedEntity>]
+  def available_actions issue_key
+    array_jira_call JIRA::NamedEntity, 'getAvailableActions', issue_key
+  end
+  deprecate :available_actions
 
 end

data/lib/jiraSOAP/api/project_roles.rb

@@ -6,14 +6,14 @@ module JIRA::RemoteAPI
   def project_roles
     array_jira_call JIRA::ProjectRole, 'getProjectRoles'
   end
-  alias_method :get_project_roles, :project_roles
+  deprecate :project_roles
 
   # @param [String] role_id
   # @return [JIRA::ProjectRole]
   def project_role_with_id role_id
     JIRA::ProjectRole.new_with_xml jira_call( 'getProjectRole', role_id )
   end
-  alias_method :get_project_role_with_id, :project_role_with_id
+  deprecate :project_role_with_id
 
   # @param [JIRA::ProjectRole] project_role
   # @return [JIRA::ProjectRole] the role that was created

data/lib/jiraSOAP/api/projects.rb

@@ -12,14 +12,14 @@ module JIRA::RemoteAPI
   def project_with_key project_key
     JIRA::Project.new_with_xml jira_call( 'getProjectByKey', project_key )
   end
-  alias_method :get_project_with_key, :project_with_key
+  deprecate :project_with_key
 
   # @param [String] project_id
   # @return [JIRA::Project]
   def project_with_id project_id
     JIRA::Project.new_with_xml jira_call( 'getProjectById', project_id )
   end
-  alias_method :get_project_with_id, :project_with_id
+  deprecate :project_with_id
 
   ##
   # @todo Parse the permission scheme
@@ -30,7 +30,7 @@ module JIRA::RemoteAPI
   def project_including_schemes_with_id project_id
     JIRA::Project.new_with_xml jira_call( 'getProjectWithSchemesById', project_id )
   end
-  alias_method :get_project_including_schemes_with_id, :project_including_schemes_with_id
+  deprecate :project_including_schemes_with_id
 
   ##
   # @note This will not fill in {JIRA::Scheme} data for the projects.
@@ -39,7 +39,9 @@ module JIRA::RemoteAPI
   def projects
     array_jira_call JIRA::Project, 'getProjectsNoSchemes'
   end
-  alias_method :get_projects, :projects
+  alias_method :projects_without_schemes, :projects
+  deprecate :projects
+  deprecate :projects_without_schemes
 
   ##
   # Requires you to set at least a project name, key, and lead.

data/lib/jiraSOAP/api/schemes.rb

@@ -6,12 +6,12 @@ module JIRA::RemoteAPI
   def notification_schemes
     array_jira_call JIRA::NotificationScheme, 'getNotificationSchemes'
   end
-  alias_method :get_notification_schemes, :notification_schemes
+  deprecate :notification_schemes
 
   # @return [Array<JIRA::PermissionScheme>]
   def permission_schemes
     array_jira_call JIRA::PermissionScheme, 'getPermissionSchemes'
   end
-  alias_method :get_permission_schemes, :permission_schemes
+  deprecate :permission_schemes
 
 end

data/lib/jiraSOAP/api/server_info.rb

@@ -9,12 +9,12 @@ module JIRA::RemoteAPI
   def server_info
     JIRA::ServerInfo.new_with_xml jira_call( 'getServerInfo' )
   end
-  alias_method :get_server_info, :server_info
+  deprecate :server_info
 
   # @return [JIRA::ServerConfiguration]
   def server_configuration
     JIRA::ServerConfiguration.new_with_xml jira_call( 'getConfiguration' )
   end
-  alias_method :get_server_configuration, :server_configuration
+  deprecate :server_configuration
 
 end

data/lib/jiraSOAP/api/users.rb

@@ -7,7 +7,7 @@ module JIRA::RemoteAPI
   def user_with_name user_name
     JIRA::User.new_with_xml jira_call( 'getUser', user_name )
   end
-  alias_method :get_user_with_name, :user_with_name
+  deprecate :user_with_name
 
   ##
   # It seems that creating a user without any permission groups will trigger
@@ -39,7 +39,7 @@ module JIRA::RemoteAPI
     frag = jira_call 'getGroup', group_name
     JIRA::UserGroup.new_with_xml frag
   end
-  alias_method :get_group_with_name, :group_with_name
+  deprecate :group_with_name
 
   # @param [JIRA::UserGroup] group
   # @param [JIRA::User] user

data/lib/jiraSOAP/api/versions.rb

@@ -7,7 +7,7 @@ module JIRA::RemoteAPI
   def versions_for_project project_key
     array_jira_call JIRA::Version, 'getVersions', project_key
   end
-  alias_method :get_versions_for_project, :versions_for_project
+  deprecate :versions_for_project
 
   ##
   # New versions cannot have the archived bit set and the release date

data/lib/jiraSOAP/core_extensions.rb

@@ -2,7 +2,10 @@
 # Monkey patches to allow the SOAP building method to not need
 # a special case for dealing with arrays.
 class Array
-  def to_soap
-    raise NotImplementedError
+
+  # @param [Handsoap::XmlMason::Node] msg message the node to add the object to
+  def soapify_for msg
+    each { |item| item.soapify_for msg }
   end
+
 end

data/lib/jiraSOAP/entities/comment.rb

@@ -40,7 +40,7 @@ class JIRA::Comment < JIRA::DynamicEntity
   #
   # @param [Handsoap::XmlMason::Node] msg
   # @return [Handsoap::XmlMason::Node]
-  def soapify_for(msg)
+  def soapify_for msg
     msg.add 'id', @id
     msg.add 'author', @author
     msg.add 'body', @body

data/lib/jiraSOAP/entities/custom_field_value.rb

@@ -21,7 +21,7 @@ class JIRA::CustomFieldValue < JIRA::DynamicEntity
   # @param [Handsoap::XmlMason::Node] msg SOAP message to add the object to
   # @param [String] label tag name used in wrapping tags
   # @return [Handsoap::XmlMason::Element]
-  def soapify_for(msg, label = 'customFieldValues')
+  def soapify_for msg, label = 'customFieldValues'
     msg.add label do |submsg|
       submsg.add 'customfieldId', @id
       submsg.add 'key', @key

data/lib/jiraSOAP/entities/field_value.rb

@@ -30,7 +30,7 @@ class JIRA::FieldValue
   # @param [Handsoap::XmlMason::Node] message the node to add the object to
   # @param [String] label name for the tags that wrap the message
   # @return [Handsoap::XmlMason::Element]
-  def soapify_for(message, label = 'fieldValue')
+  def soapify_for message, label = 'fieldValue'
     message.add label do |message|
       message.add 'id', @field_name
       message.add_simple_array 'values', @values unless @values.nil?

data/lib/jiraSOAP/entities/server_configuration.rb

@@ -1,5 +1,5 @@
 ##
-# A simple structure that is used by {RemoteAPI#get_server_configuration}.
+# A simple structure that is used by {RemoteAPI#server_configuration}.
 class JIRA::ServerConfiguration < JIRA::Entity
 
   # @return [Boolean]

data/lib/jiraSOAP/entities/server_info.rb

@@ -1,6 +1,6 @@
 ##
 # Only contains basic information about the endpoint server and only used
-# by {RemoteAPI#get_server_info}.
+# by {RemoteAPI#server_info}.
 class JIRA::ServerInfo < JIRA::Entity
 
   # @return [NSURL,URI::HTTP]

data/lib/jiraSOAP/entities/time_info.rb

@@ -1,6 +1,6 @@
 ##
 # Simple structure for a time and time zone; only used by JIRA::ServerInfo
-# objects, which themselves are only created when {RemoteAPI#get_server_info}
+# objects, which themselves are only created when {RemoteAPI#server_info}
 # is called.
 class JIRA::TimeInfo < JIRA::Entity
 

data/lib/jiraSOAP/entities/version.rb

@@ -19,7 +19,7 @@ class JIRA::Version < JIRA::NamedEntity
 
   # @param [Handsoap::XmlMason::Node] msg
   # @return [Handsoap::XmlMason::Node]
-  def soapify_for(msg)
+  def soapify_for msg
     msg.add 'name', @name
     msg.add 'archived', @archived if @archived
     msg.add 'sequence', @sequence if @sequence

data/lib/jiraSOAP/jira_service.rb

@@ -43,18 +43,6 @@ class JIRA::JIRAService < Handsoap::Service
     })
   end
 
-  ##
-  # An extra note for users when things break.
-  #
-  # @deprecated This will be removed in v1.0 when the API is stable.
-  # @return [nil]
-  def method_missing method, *args
-    message  = "#{method} is not a valid method. Check the documentation; the "
-    message << 'API is not stabale yet and the method name likely changed.'
-    STDERR.puts message
-    super method, *args
-  end
-
 
   protected
 

data/lib/jiraSOAP/url.rb

@@ -2,6 +2,7 @@ module JIRA
 
   class << self
 
+    ##
     # When running on MacRuby, a URL will be wrapped into an NSURL object;
     # but on all other Ruby implementations you will get a URI::HTTP object.
     # The NSURL class is monkey patched just enough to make NSURL and
@@ -12,10 +13,13 @@ module JIRA
     #     JIRA.url_class.send JIRA.url_init_method, 'http://marketcircle.com'
     #
     # will be working code.
+    #
     # @return [Class,Module]
     attr_accessor :url_class
 
+    ##
     # We also need a variable for the init method for a URL object
+    #
     # @return [Symbol]
     attr_accessor :url_init_method
 

data/lib/jiraSOAP/version.rb

@@ -1,3 +1,4 @@
 module JIRA
-  VERSION = '0.8.6'
+  # @return [String]
+  VERSION = '0.9.0'
 end

data/test/progressWorkflowActionTest.rb

@@ -0,0 +1,8 @@
+class TestProgressWorkflowActionTest < MiniTest::Unit::TestCase
+  setup_usual
+
+  def test_some_bullshit
+    assert true
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jiraSOAP
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,23 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-20 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70183021802840 !ruby/object:Gem::Requirement
+  requirement: &70264277917080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.4
+        version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70183021802840
+  version_requirements: *70264277917080
 - !ruby/object:Gem::Dependency
   name: handsoap
-  requirement: &70183021802320 !ruby/object:Gem::Requirement
+  requirement: &70264277916320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,40 +32,40 @@ dependencies:
         version: 1.1.8
   type: :runtime
   prerelease: false
-  version_requirements: *70183021802320
+  version_requirements: *70264277916320
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70183021801840 !ruby/object:Gem::Requirement
+  requirement: &70264277915600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *70183021801840
+  version_requirements: *70264277915600
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70183021801360 !ruby/object:Gem::Requirement
+  requirement: &70264277915140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.17'
   type: :development
   prerelease: false
-  version_requirements: *70183021801360
+  version_requirements: *70264277915140
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70183021800880 !ruby/object:Gem::Requirement
+  requirement: &70264277914680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.3.1
   type: :development
   prerelease: false
-  version_requirements: *70183021800880
+  version_requirements: *70264277914680
 description: Written to run fast and work on Ruby 1.9 as well as MacRuby
 email:
 - mrada@marketcircle.com
@@ -76,7 +75,6 @@ extra_rdoc_files:
 - README.markdown
 - ChangeLog
 - LICENSE.txt
-- .yardopts
 - docs/GettingStarted.markdown
 - docs/Examples.markdown
 files:
@@ -138,16 +136,16 @@ files:
 - lib/jiraSOAP/url.rb
 - lib/jiraSOAP/version.rb
 - lib/jiraSOAP.rb
+- .yardopts
+- Rakefile
 - test/jiraSOAP_test.rb
+- test/progressWorkflowActionTest.rb
 - test/test_helper.rb
-- Rakefile
 - README.markdown
 - ChangeLog
 - LICENSE.txt
-- .yardopts
 - docs/GettingStarted.markdown
 - docs/Examples.markdown
-has_rdoc: true
 homepage: http://github.com/Marketcircle/jiraSOAP
 licenses:
 - MIT
@@ -169,11 +167,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A Ruby client for the JIRA SOAP API
 test_files:
 - test/jiraSOAP_test.rb
+- test/progressWorkflowActionTest.rb
 - test/test_helper.rb
-- Rakefile