jiraSOAP 0.6.1 → 0.7.1

data/lib/jiraSOAP/entities/issue_property.rb

@@ -2,8 +2,8 @@
 #  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
+  add_attributes(
+    # NSURL on MacRuby and a URI::HTTP object on CRuby
+    ['icon', :icon, :to_url]
+  )
 end

data/lib/jiraSOAP/entities/issue_security_scheme.rb

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

data/lib/jiraSOAP/entities/issue_type.rb

@@ -1,8 +1,7 @@
 # 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
+  add_attributes(
+    # True if the issue type is also a subtask.
+    ['subTask', :subtask, :to_boolean]
+  )
 end

data/lib/jiraSOAP/entities/named_entity.rb

@@ -1,7 +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
+  add_attributes(
+    # A plain language name.
+    ['name', :name, :to_s]
+  )
 end

data/lib/jiraSOAP/entities/notification_scheme.rb

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

data/lib/jiraSOAP/entities/permission.rb

@@ -1,12 +1,9 @@
+# A permission id and the username that it is tied to.
 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
+  add_attributes(
+    # The permission type
+    ['name',       :name,       :to_s],
+    # A unique id number
+    ['permission', :permission, :to_i]
+  )
 end

data/lib/jiraSOAP/entities/permission_mapping.rb

@@ -1,12 +1,7 @@
+# @todo make sure the xml names are correct (check the XML dump)
 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
+  add_attributes(
+    ['permission', :permission, :to_object,  JIRA::Permission],
+    ['entities',   :users,      :to_objects, JIRA::UserName]
+  )
 end

data/lib/jiraSOAP/entities/permission_scheme.rb

@@ -1,8 +1,7 @@
 # @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
+  add_attributes(
+    ['permissionMappings', :permission_mappings, :to_objects, JIRA::PermissionMapping]
+  )
 end

data/lib/jiraSOAP/entities/priority.rb

@@ -1,9 +1,10 @@
 # Contains all the metadata for a priority level.
 class JIRA::Priority < JIRA::IssueProperty
-  add_attributes({ 'color' => [:color=, :to_hex_string] })
+  add_attributes(
+    # the RGB components as a triple
+    ['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,35 +1,14 @@
 # Contains the data and metadata about a project and its configuration.
 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 :jira_url
-
-  # @return [URL]
-  attr_accessor :project_url
-
-  # @return [String]
-  attr_accessor :lead_username
-
-  # @return [JIRA::IssueSecurityScheme]
-  attr_accessor :issue_security_scheme
-
-  # @return [JIRA::NotificationScheme]
-  attr_accessor :notification_scheme
-
-  # @return [JIRA::PermissionScheme]
-  attr_accessor :permission_scheme
+  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]
+  )
 
   # @todo make this method shorter
   # @todo encode the schemes

data/lib/jiraSOAP/entities/project_role.rb

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

data/lib/jiraSOAP/entities/resolution.rb

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

data/lib/jiraSOAP/entities/scheme.rb

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

data/lib/jiraSOAP/entities/server_configuration.rb

@@ -1,56 +1,17 @@
 # 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
+  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]
+  )
 end

data/lib/jiraSOAP/entities/server_info.rb

@@ -1,30 +1,12 @@
 # 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
+  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]
+  )
 end

data/lib/jiraSOAP/entities/status.rb

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

data/lib/jiraSOAP/entities/time_info.rb

@@ -2,14 +2,9 @@
 # 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
+  add_attributes(
+    ['serverTime', :server_time, :to_date_string],
+    # in the form of 'America/Toronto'
+    ['timeZoneId', :timezone,    :to_s]
+  )
 end

data/lib/jiraSOAP/entities/user.rb

@@ -1,18 +1,8 @@
 # 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
-
-  # @return [String]
-  attr_accessor :full_name
-
-  # @return [String]
-  attr_accessor :email_address
+class JIRA::User < JIRA::UserName
+  add_attributes(
+    ['fullname', :full_name,     :to_s],
+    ['email',    :email_address, :to_s]
+  )
 end

data/lib/jiraSOAP/entities/username.rb

@@ -0,0 +1,4 @@
+# This is just a @name, JIRA::User should inherit from this class
+class JIRA::UserName < JIRA::Entity
+  add_attributes(['name', :username, :to_s])
+end

data/lib/jiraSOAP/entities/version.rb

@@ -2,26 +2,12 @@
 # Represents a version for a project. The description field is never
 # included when you retrieve versions from the server.
 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
-
-  # @return [boolean]
-  attr_accessor :released
-  alias_method :released?, :released
-
-  # @return [boolean]
-  attr_accessor :archived
-  alias_method :archived?, :archived
-
-  # @return [Time]
-  attr_accessor :release_date
+  add_attributes(
+    ['sequence',    :sequence,     :to_i],
+    ['released',    :released,     :to_boolean],
+    ['archived',    :archived,     :to_boolean],
+    ['releaseDate', :release_date, :to_date]
+  )
 
   # @todo make this method shorter
   # @param [Handsoap::XmlMason::Node] msg

data/lib/jiraSOAP/handsoap_extensions.rb

@@ -1,6 +1,7 @@
 # Some simple extensions to Handsoap.
 module Handsoap
 
+# @todo check if these methods already exist in Handsoap::Service
 # Some extensions to the XML builder to make message building less ugly.
 module XmlMason
 
@@ -35,6 +36,7 @@ end
 # These are simple extensions to the existing class provided by Handsoap.
 module XmlQueryFront
 
+  # @todo move these extensions straight to the nokogiri layer
   # Simple extensions on the existing Handsoap class to make parsing easier.
   class NokogiriDriver
 
@@ -54,11 +56,11 @@ module XmlQueryFront
       temp.match(/#(..)(..)(..)/).captures
     end
 
-    # @return [URL]
+    # @return [URI::HTTP,NSURL]
     def to_url
       temp = self.to_s
       return unless temp
-      URL.new temp
+      JIRA.url_class.send JIRA.url_init_method, temp
     end
 
     # Returns the node's children to an array of strings.

data/lib/jiraSOAP/macruby_bonuses.rb

@@ -1,16 +1,23 @@
 framework 'Foundation'
 
-class URL
-  def initialize(url_string)
-    @url = NSURL.URLWithString url_string
-  end
+# In the case of MacRuby, we extend NSURL to behave enough like a
+# URI::HTTP object that they can be interchanged.
+class NSURL
 
+  # We have to override, using {#alias_method} does not work because
+  # {#to_s} is defined in the base class.
+  # @return [String]
   def to_s
-    @url.absoluteString
+    absoluteString
   end
+
 end
 
+
 # @todo get a parallel map method for collections
 module JIRA
 
+  @url_class       = NSURL
+  @url_init_method = :'URLWithString:'
+
 end