jiraSOAP 0.5.3 → 0.6.0

data/lib/jiraSOAP/entities/issue_property.rb

@@ -0,0 +1,9 @@
+# @abstract A common base for most issue properties; core issue properties
+#  have an icon to go with them to help identify properties of issues more
+#  quickly.
+class JIRA::IssueProperty < JIRA::DescribedEntity
+  add_attributes({ 'icon' => [:icon=, :to_url] })
+
+  # @return [URL] NSURL on MacRuby and a URI::HTTP object on CRuby
+  attr_accessor :icon
+end

data/lib/jiraSOAP/entities/issue_security_scheme.rb

@@ -0,0 +1,4 @@
+# Basic metadata about a project's issue security scheme.
+class JIRA::IssueSecurityScheme < JIRA::Scheme
+  add_attributes({})
+end

data/lib/jiraSOAP/entities/issue_type.rb

@@ -0,0 +1,8 @@
+# Contains all the metadata for an issue type.
+class JIRA::IssueType < JIRA::IssueProperty
+  add_attributes({ 'subTask' => [:subtask=, :to_boolean] })
+
+  # @return [boolean]  true if the issue type is also a subtask
+  attr_accessor :subtask
+  alias_method :subtask?, :subtask
+end

data/lib/jiraSOAP/entities/named_entity.rb

@@ -0,0 +1,7 @@
+# @abstract Most dynamic entities also have a name
+class JIRA::NamedEntity < JIRA::DynamicEntity
+  add_attributes({ 'name' => [:name=, :to_s] })
+
+  # @return [String] a plain language name
+  attr_accessor :name
+end

data/lib/jiraSOAP/entities/notification_scheme.rb

@@ -0,0 +1,4 @@
+# Basic metadata about a project's notification scheme.
+class JIRA::NotificationScheme < JIRA::Scheme
+  add_attributes({})
+end

data/lib/jiraSOAP/entities/permission.rb

@@ -0,0 +1,12 @@
+class JIRA::Permission < JIRA::Entity
+  add_attributes({
+    'name'       => [:name=,       :to_s],
+    'permission' => [:permission=, :to_i]
+  })
+
+  # @return [String] the permission type
+  attr_accessor :name
+
+  # @return [Fixnum] a unique id number
+  attr_accessor :permission
+end

data/lib/jiraSOAP/entities/permission_mapping.rb

@@ -0,0 +1,12 @@
+class JIRA::PermissionMapping < JIRA::Entity
+  @attributes = {
+    'permission' => [:permission=, :to_object,  JIRA::Permission],
+    'permission' => [:permission=, :to_objects, JIRA::Permission]
+  }
+
+  # @return [JIRA::Permission]
+  attr_accessor :permission
+
+  # @return [[JIRA::RemoteEntity]]
+  attr_accessor :remote_entities
+end

data/lib/jiraSOAP/entities/permission_scheme.rb

@@ -0,0 +1,8 @@
+# @todo complete this class
+# Includes a mapping of project specific permission settings.
+class JIRA::PermissionScheme < JIRA::Scheme
+  add_attributes({})
+
+  # @return [nil]
+  attr_accessor :permission_mappings
+end

data/lib/jiraSOAP/entities/priority.rb

@@ -0,0 +1,9 @@
+# Contains all the metadata for a priority level.
+class JIRA::Priority < JIRA::IssueProperty
+  add_attributes({ 'color' => [:color=, :to_hex_string] })
+
+  # @return [Array(String,String,String)] the RGB components as a triple
+  attr_accessor :color
+  alias_method :colour, :color
+  alias_method :colour=, :color=
+end

data/lib/jiraSOAP/entities/project.rb

@@ -1,19 +1,26 @@
-module JIRA
-
 # Contains the data and metadata about a project and its configuration.
-class Project < JIRA::DescribedEntity
+class JIRA::Project < JIRA::DescribedEntity
+  add_attributes({
+    'key'                 => [:key=,                   :to_s],
+    'lead'                => [:lead_username=,         :to_s],
+    'issueSecurityScheme' => [:issue_security_scheme=, :to_object, JIRA::IssueSecurityScheme],
+    'notificationScheme'  => [:notification_scheme=,   :to_object, JIRA::NotificationScheme],
+    'permissionScheme'    => [:permission_scheme=,     :to_object, JIRA::PermissionScheme],
+    'url'                 => [:jira_url=,              :to_url],
+    'projectUrl'          => [:project_url=,           :to_url]
+  })
 
   # @return [String]
   attr_accessor :key
 
   # @return [URL]
-  attr_accessor :url
+  attr_accessor :jira_url
 
   # @return [URL]
   attr_accessor :project_url
 
   # @return [String]
-  attr_accessor :lead
+  attr_accessor :lead_username
 
   # @return [JIRA::IssueSecurityScheme]
   attr_accessor :issue_security_scheme
@@ -24,21 +31,6 @@ class Project < JIRA::DescribedEntity
   # @return [JIRA::PermissionScheme]
   attr_accessor :permission_scheme
 
-  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
-  def initialize_with_xml_fragment(frag)
-    super frag
-    @key, @lead,
-    @issue_security_scheme, @notification_scheme, @permission_scheme,
-    @url, @project_url =
-      frag.nodes( ['key',                 :to_s],
-                  ['lead',                :to_s],
-                  ['issueSecurityScheme', :to_object, JIRA::IssueSecurityScheme],
-                  ['notificationScheme',  :to_object, JIRA::NotificationScheme],
-                  ['permissionScheme',    :to_object, JIRA::PermissionScheme],
-                  ['url',                 :to_url],
-                  ['projectUrl',          :to_url] )
-  end
-
   # @todo make this method shorter
   # @todo encode the schemes
   # @param [Handsoap::XmlMason::Node] msg
@@ -47,11 +39,9 @@ class Project < JIRA::DescribedEntity
     msg.add 'id', @id
     msg.add 'name', @name
     msg.add 'key', @key
-    msg.add 'url', @url
+    msg.add 'url', @jira_url
     msg.add 'projectUrl', @project_url
-    msg.add 'lead', @lead
+    msg.add 'lead', @lead_username
     msg.add 'description', @description
   end
 end
-
-end

data/lib/jiraSOAP/entities/project_role.rb

@@ -0,0 +1,11 @@
+# Only a name, description and id.
+class JIRA::ProjectRole < JIRA::DescribedEntity
+  add_attributes({})
+
+  # @param [Handsoap::XmlMason::Node] msg the node where to add self
+  def soapify_for msg
+    msg.add 'id', @id
+    msg.add 'name', @name
+    msg.add 'description', @description
+  end
+end

data/lib/jiraSOAP/entities/remote_entity.rb

@@ -0,0 +1,7 @@
+# This is just a @name, JIRA::User should inherit from this class
+class JIRA::RemoteEntity < JIRA::Entity
+  add_attributes({ 'name' => [:name=, :to_s] })
+
+  # @return [String]
+  attr_accessor :name
+end

data/lib/jiraSOAP/entities/resolution.rb

@@ -0,0 +1,4 @@
+# Contains all the metadata for a resolution.
+class JIRA::Resolution < JIRA::IssueProperty
+  add_attributes({})
+end

data/lib/jiraSOAP/entities/scheme.rb

@@ -0,0 +1,9 @@
+# @abstract
+# Schemes used by the server.
+class JIRA::Scheme < JIRA::DescribedEntity
+  add_attributes({})
+
+  # Child classes need to be careful when encoding the scheme type to XML.
+  # @return [Class]
+  alias_method :type, :class
+end

data/lib/jiraSOAP/entities/server_configuration.rb

@@ -0,0 +1,56 @@
+# A simple structure that is used by {RemoteAPI#get_server_configuration}.
+class JIRA::ServerConfiguration < JIRA::Entity
+  add_attributes({
+    'allowExternalUserManagement' => [:external_user_management_allowed=, :to_boolean],
+    'allowAttachments'            => [:attachments_allowed=,              :to_boolean],
+    'allowIssueLinking'           => [:issue_linking_allowed=,            :to_boolean],
+    'allowSubTasks'               => [:subtasks_allowed=,                 :to_boolean],
+    'allowTimeTracking'           => [:time_tracking_allowed=,            :to_boolean],
+    'allowUnassignedIssues'       => [:unassigned_issues_allowed=,        :to_boolean],
+    'allowVoting'                 => [:voting_allowed=,                   :to_boolean],
+    'allowWatching'               => [:watching_allowed=,                 :to_boolean],
+    'timeTrackingDaysPerWeek'     => [:time_tracking_days_per_week=,      :to_i],
+    'timeTrackingHoursPerDay'     => [:time_tracking_hours_per_day=,      :to_i],
+
+    # in case we are using a version of JIRA that misspells 'management'
+    'allowExternalUserManagment'  => [:external_user_management_allowed=, :to_boolean]
+  })
+
+  # @return [boolean]
+  attr_accessor :attachments_allowed
+  alias_method :attachments_allowed?, :attachments_allowed
+
+  # @return [boolean]
+  attr_accessor :external_user_management_allowed
+  alias_method :external_user_management_allowed?, :external_user_management_allowed
+
+  # @return [boolean]
+  attr_accessor :issue_linking_allowed
+  alias_method :issue_linking_allowed?, :issue_linking_allowed
+
+  # @return [boolean]
+  attr_accessor :subtasks_allowed
+  alias_method :subtasks_allowed?, :subtasks_allowed
+
+  # @return [boolean]
+  attr_accessor :time_tracking_allowed
+  alias_method :time_tracking_allowed?, :time_tracking_allowed
+
+  # @return [boolean]
+  attr_accessor :unassigned_issues_allowed
+  alias_method :unassigned_issues_allowed?, :unassigned_issues_allowed
+
+  # @return [boolean]
+  attr_accessor :voting_allowed
+  alias_method :voting_allowed?, :voting_allowed
+
+  # @return [boolean]
+  attr_accessor :watching_allowed
+  alias_method :watching_allowed?, :watching_allowed
+
+  # @return [Fixnum]
+  attr_accessor :time_tracking_days_per_week
+
+  # @return [Fixnum]
+  attr_accessor :time_tracking_hours_per_day
+end

data/lib/jiraSOAP/entities/server_info.rb

@@ -0,0 +1,30 @@
+# Only contains basic information about the endpoint server and only used
+# by {RemoteAPI#get_server_info}.
+class JIRA::ServerInfo < JIRA::Entity
+  add_attributes({
+    'baseUrl'     => [:base_url=,     :to_url],
+    'buildDate'   => [:build_date=,   :to_date],
+    'buildNumber' => [:build_number=, :to_i],
+    'edition'     => [:edition=,      :to_s],
+    'version'     => [:version=,      :to_s],
+    'serverTime'  => [:server_time=,  :to_object, JIRA::TimeInfo]
+  })
+
+  # @return [URL]
+  attr_accessor :base_url
+
+  # @return [Time]
+  attr_accessor :build_date
+
+  # @return [Fixnum]
+  attr_accessor :build_number
+
+  # @return [String]
+  attr_accessor :edition
+
+  # @return [String]
+  attr_accessor :version
+
+  # @return [JIRA::TimeInfo]
+  attr_accessor :server_time
+end

data/lib/jiraSOAP/entities/status.rb

@@ -0,0 +1,4 @@
+# Contains all the metadata for an issue's status.
+class JIRA::Status < JIRA::IssueProperty
+  add_attributes({})
+end

data/lib/jiraSOAP/entities/time_info.rb

@@ -0,0 +1,15 @@
+# Simple structure for a time and time zone; only used by JIRA::ServerInfo
+# objects, which themselves are only created when {RemoteAPI#get_server_info}
+# is called.
+class JIRA::TimeInfo < JIRA::Entity
+  add_attributes({
+    'serverTime' => [:server_time=, :to_date_string],
+    'timeZoneId' => [:timezone=,    :to_s]
+  })
+
+  # @return [Time]
+  attr_accessor :server_time
+
+  # @return [String] in the form of 'America/Toronto'
+  attr_accessor :timezone
+end

data/lib/jiraSOAP/entities/user.rb

@@ -1,8 +1,11 @@
-module JIRA
-
-# Contains the basic information about a user. The only things missing here
-# are the permissions and login statistics.
-class User < JIRA::Entity
+# Contains only the basic information about a user. The only things missing here
+# are the permissions and login statistics, but these are not given in the API.
+class JIRA::User < JIRA::Entity
+  add_attributes({
+    'name'     => [:username=,      :to_s],
+    'fullname' => [:full_name=,     :to_s],
+    'email'    => [:email_address=, :to_s]
+  })
 
   # @return [String]
   attr_accessor :username
@@ -12,12 +15,4 @@ class User < JIRA::Entity
 
   # @return [String]
   attr_accessor :email_address
-
-  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
-  def initialize_with_xml_fragment(frag)
-    @username, @full_name, @email_address =
-      frag.nodes ['name', :to_s], ['fullname', :to_s], ['email', :to_s]
-  end
-end
-
 end

data/lib/jiraSOAP/entities/version.rb

@@ -1,9 +1,13 @@
-module JIRA
-
+# @todo find out why we don't get a description for this object
 # Represents a version for a project. The description field is never
 # included when you retrieve versions from the server.
-# @todo find out why we don't get a description for this object
-class Version < JIRA::NamedEntity
+class JIRA::Version < JIRA::NamedEntity
+  add_attributes({
+    'sequence'    => [:sequence=,     :to_i],
+    'released'    => [:released=,     :to_boolean],
+    'archived'    => [:archived=,     :to_boolean],
+    'releaseDate' => [:release_date=, :to_date]
+  })
 
   # @return [Fixnum]
   attr_accessor :sequence
@@ -19,16 +23,6 @@ class Version < JIRA::NamedEntity
   # @return [Time]
   attr_accessor :release_date
 
-  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
-  def initialize_with_xml_fragment(frag)
-    super frag
-    @sequence, @released, @archived, @release_date =
-      frag.nodes( ['sequence',    :to_i],
-                  ['released',    :to_boolean],
-                  ['archived',    :to_boolean],
-                  ['releaseDate', :to_date] )
-  end
-
   # @todo make this method shorter
   # @param [Handsoap::XmlMason::Node] msg
   # @return [Handsoap::XmlMason::Node]
@@ -40,5 +34,3 @@ class Version < JIRA::NamedEntity
     msg.add 'released', @released unless @released.nil?
   end
 end
-
-end

data/lib/jiraSOAP/handsoap_extensions.rb

@@ -1,10 +1,12 @@
 # Some simple extensions to Handsoap.
 module Handsoap
-# Some simple extensions to XmlMason. Currently, this only includes methods to
-# make it easier to build SOAP messages that contain arrays.
+
+# Some extensions to the XML builder to make message building less ugly.
 module XmlMason
-  # Represents a node in an XML document used for SOAP message creation.
+
+  # A node in a Nokogiri XML document.
   class Node
+
     # @todo Make this method recursive
     # @param [String] node_name
     # @param [Array] array
@@ -24,32 +26,34 @@ module XmlMason
       node = append_child Element.new(self, prefix, name, nil, options)
       array.each { |element| element.soapify_for node, name }
     end
+
   end
+
 end
 
-# Some simple extensions to make initialization of JIRA objects cleaner.
+
+# These are simple extensions to the existing class provided by Handsoap.
 module XmlQueryFront
-  # Represents a node in an XML document used when parsing SOAP responses.
-  # This class is extended for use with jiraSOAP.
-  class NokogiriDriver
 
-    # @param [Array] *attributes pairs or triplets, the first element is the
-    #  attribute you want, the second element is the method to send to the
-    #  result, and the third element is the argument to that method (if needed)
-    # @return [[Objects]]
-    def nodes(*attributes)
-      attributes.map { |attr|
-        self.xpath(attr.shift).send *attr
-      }
-    end
+  # Simple extensions on the existing Handsoap class to make parsing easier.
+  class NokogiriDriver
 
+    # Parses non-strict date strings into Time objects.
     # @return [Time]
-    def to_string_date
+    def to_date_string
       temp = self.to_s
       return unless temp
       Time.new temp
     end
 
+    # This is a bit naive, but should be sufficient for its purpose.
+    # @return [String]
+    def to_hex_string
+      temp = self.to_s
+      return unless temp
+      temp.match(/#(..)(..)(..)/).captures
+    end
+
     # @return [URL]
     def to_url
       temp = self.to_s
@@ -57,39 +61,22 @@ module XmlQueryFront
       URL.new temp
     end
 
+    # Returns the node's children to an array of strings.
     # @return [[String]]
     def to_ss
-      self.map { |val| val.to_s }
+      children.map { |val| val.to_s }
     end
-  end
 
-  # Simple additions to help expedite parsing XML.
-  class NodeSelection
-    # @return [URL]
-    def to_url
-      self.first.to_url if self.any?
-    end
-
-    # @return [Time]
-    def to_string_date
-      self.first.to_string_date
-    end
-
-    # @return [[String]]
-    def to_ss
-      self.map { |val| val.to_s }
+    # @param [Class] klass the object you want to make
+    # @return [Object] an instance of klass
+    def to_object klass
+      klass.new_with_xml self
     end
 
     # @param [Class] klass the object you want an array of
     # @return [Array] an array of klass objects
-    def to_objects(klass)
-      self.map { |frag| klass.new_with_xml_fragment frag }
-    end
-
-    # @param [Class] klass the object you want to make
-    # @return [Object] an instance of klass
-    def to_object(klass)
-      klass.new_with_xml_fragment self.first if self.any?
+    def to_objects klass
+      children.map { |node| klass.new_with_xml node }
     end
   end
 end