jiraSOAP 0.4.0 → 0.5.0

data/lib/jiraSOAP/entities/issue_properties.rb

@@ -0,0 +1,41 @@
+module JIRA
+
+# Contains all the metadata for a resolution.
+class Resolution < JIRA::IssueProperty
+end
+
+# Contains all the metadata for an issue's status.
+class Status < JIRA::IssueProperty
+end
+
+# Contains all the metadata for a priority level.
+# @todo change @color to be some kind of hex Fixnum object
+class Priority < JIRA::IssueProperty
+
+  # @return [String] is a hex value
+  attr_accessor :color
+
+  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
+  def initialize_with_xml_fragment(frag)
+    super frag
+    @color = (frag/'color').to_s
+  end
+end
+
+# Contains all the metadata for an issue type.
+class IssueType < JIRA::IssueProperty
+
+  # @return [boolean]
+  attr_accessor :subtask
+
+  # @return [boolean] true if the issue type is a subtask, otherwise false
+  def subtask?; @subtask; end
+
+  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
+  def initialize_with_xml_fragment(frag)
+    super frag
+    @subtask = (frag/'subTask').to_boolean
+  end
+end
+
+end

data/lib/jiraSOAP/entities/project.rb

@@ -0,0 +1,57 @@
+module JIRA
+
+# Contains the data and metadata about a project and its configuration.
+class Project < JIRA::DescribedEntity
+
+  # @return [String]
+  attr_accessor :key
+
+  # @return [URL]
+  attr_accessor :url
+
+  # @return [URL]
+  attr_accessor :project_url
+
+  # @return [String]
+  attr_accessor :lead
+
+  # @return [JIRA::IssueSecurityScheme]
+  attr_accessor :issue_security_scheme
+
+  # @return [JIRA::NotificationScheme]
+  attr_accessor :notification_scheme
+
+  # @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
+  # @return [Handsoap::XmlMason::Node]
+  def soapify_for(msg)
+    msg.add 'id', @id
+    msg.add 'name', @name
+    msg.add 'key', @key
+    msg.add 'url', @url
+    msg.add 'projectUrl', @project_url
+    msg.add 'lead', @lead
+    msg.add 'description', @description
+  end
+end
+
+end

data/lib/jiraSOAP/entities/read_only.rb

@@ -0,0 +1,121 @@
+module JIRA
+
+# Only contains basic information about the endpoint server and only used
+# by {RemoteAPI#get_server_info}.
+class ServerInfo < JIRA::Entity
+
+  # @return [URL]
+  attr_reader :base_url
+
+  # @return [Time]
+  attr_reader :build_date
+
+  # @return [Fixnum]
+  attr_reader :build_number
+
+  # @return [String]
+  attr_reader :edition
+
+  # @return [JIRA::TimeInfo]
+  attr_reader :server_time
+
+  # @return [String]
+  attr_reader :version
+
+  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
+  def initialize_with_xml_fragment(frag)
+    @build_date, @build_number, @base_url, @edition, @version, @server_time =
+      frag.nodes( ['buildDate',   :to_date],
+                  ['buildNumber', :to_i],
+                  ['baseUrl',     :to_url],
+                  ['edition',     :to_s],
+                  ['version',     :to_s],
+                  ['serverTime',  :to_object, JIRA::TimeInfo] )
+  end
+end
+
+
+# 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 TimeInfo < JIRA::Entity
+
+  # @return [Time]
+  attr_reader :server_time
+
+  # @return [String] in the form of 'America/Toronto'
+  attr_reader :timezone
+
+  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
+  def initialize_with_xml_fragment(frag)
+    @server_time, @timezone =
+      frag.nodes ['serverTime', :to_string_date], ['timeZoneId', :to_s]
+  end
+end
+
+
+# A simple structure that is used by {RemoteAPI#get_server_configuration}.
+class ServerConfiguration < JIRA::Entity
+
+  # @return [boolean]
+  attr_reader :attachments_allowed
+
+  # @return [boolean]
+  attr_reader :external_user_management_allowed
+
+  # @return [boolean]
+  attr_reader :issue_linking_allowed
+
+  # @return [boolean]
+  attr_reader :subtasks_allowed
+
+  # @return [boolean]
+  attr_reader :time_tracking_allowed
+
+  # @return [boolean]
+  attr_reader :unassigned_issues_allowed
+
+  # @return [boolean]
+  attr_reader :voting_allowed
+
+  # @return [boolean]
+  attr_reader :watching_allowed
+
+  # @return [Fixnum]
+  attr_reader :time_tracking_days_per_week
+
+  # @return [Fixnum]
+  attr_reader :time_tracking_hours_per_day
+
+  def attachments_allowed?; @attachments_allowed; end
+  def external_user_management_allowed?; @external_user_management_allowed; end
+  def issue_linking_allowed?; @issue_linking_allowed; end
+  def subtasks_allowed?; @subtasks_allowed; end
+  def time_tracking_allowed?; @time_tracking_allowed; end
+  def unassigned_issues_allowed?; @unassigned_issues_allowed; end
+  def voting_allowed?; @voting_allowed; end
+  def watching_allowed?; @watching_allowed; end
+
+  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
+  def initialize_with_xml_fragment(frag)
+    @external_user_management_allowed, @attachments_allowed,
+    @issue_linking_allowed,            @subtasks_allowed,
+    @time_tracking_allowed,            @unassigned_issues_allowed,
+    @voting_allowed,                   @watching_allowed,
+    @time_tracking_days_per_week,      @time_tracking_hours_per_day =
+      frag.nodes( ['allowExternalUserManagement', :to_boolean],
+                  ['allowAttachments',            :to_boolean],
+                  ['allowIssueLinking',           :to_boolean],
+                  ['allowSubTasks',               :to_boolean],
+                  ['allowTimeTracking',           :to_boolean],
+                  ['allowUnassignedIssues',       :to_boolean],
+                  ['allowVoting',                 :to_boolean],
+                  ['allowWatching',               :to_boolean],
+                  ['timeTrackingDaysPerWeek',     :to_i],
+                  ['timeTrackingHoursPerDay',     :to_i] )
+    # in case Atlassian still has not fixed their spelling of 'management'
+    @external_user_management_allowed ||= (frag/'allowExternalUserManagment').to_boolean
+  end
+end
+
+end

data/lib/jiraSOAP/entities/schemes.rb

@@ -0,0 +1,25 @@
+module JIRA
+
+# @todo complete this class
+# Includes a mapping of project specific permission settings.
+class PermissionScheme < JIRA::Scheme
+
+  # @return [nil]
+  attr_accessor :permission_mappings
+
+  # @todo actually parse the permission mapping
+  # @param [Handsoap::XmlQueryFront::NokogiriDriver] frag
+  def initialize_with_xml_fragment(frag)
+    super frag
+  end
+end
+
+# Basic metadata about a project's notification scheme.
+class NotificationScheme < JIRA::Scheme
+end
+
+# Basic metadata about a project's issue security scheme.
+class IssueSecurityScheme < JIRA::Scheme
+end
+
+end

data/lib/jiraSOAP/entities/user.rb

@@ -0,0 +1,23 @@
+module JIRA
+
+# Contains the basic information about a user. The only things missing here
+# are the permissions and login statistics.
+class User < JIRA::Entity
+
+  # @return [String]
+  attr_accessor :username
+
+  # @return [String]
+  attr_accessor :full_name
+
+  # @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

@@ -0,0 +1,45 @@
+module JIRA
+
+# 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
+
+  # @return [Fixnum]
+  attr_accessor :sequence
+
+  # @return [boolean]
+  attr_accessor :released
+
+  # @return [boolean]
+  attr_accessor :archived
+
+  # @return [Time]
+  attr_accessor :release_date
+
+  def released?; @released; end
+  def archived?; @archived; end
+
+  # @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]
+  def soapify_for(msg)
+    msg.add 'name', @name
+    msg.add 'archived', @archived unless @archived.nil?
+    msg.add 'sequence', @sequence unless @sequence.nil?
+    msg.add 'releaseDate', @release_date.xmlschema unless @release_date.nil?
+    msg.add 'released', @released unless @released.nil?
+  end
+end
+
+end

data/lib/jiraSOAP/handsoap_extensions.rb

@@ -26,4 +26,72 @@ module XmlMason
     end
   end
 end
+
+# Some simple extensions to make initialization of JIRA objects cleaner.
+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
+
+    # @return [Time]
+    def to_string_date
+      temp = self.to_s
+      return unless temp
+      Time.new temp
+    end
+
+    # @return [URL]
+    def to_url
+      temp = self.to_s
+      return unless temp
+      URL.new temp
+    end
+
+    # @return [[String]]
+    def to_ss
+      self.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 }
+    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?
+    end
+  end
+end
+
 end

data/lib/{macruby_stuff.rb → jiraSOAP/macruby_bonuses.rb}

@@ -10,7 +10,7 @@ class URL
   end
 end
 
+# @todo get a parallel map method for collections
 module JIRA
-  #overrides for MacRuby
 
 end

data/lib/jiraSOAP/url.rb

@@ -1,9 +1,9 @@
 # A bit of a hack to support using an NSURL in MacRuby while still supporting
 # MRI by using the URI module.
 #
-# I suggest not thinking about it too much beyond this point: this is a
-# URI object if you are running on CRuby, but it will be an NSURL if you
-# are running on MacRuby.
+# For any JIRA entity that has a URL object as an instance variable, you can
+# stick what ever type of object you want in the instance varible, as long as
+# the object has a #to_s method that returns a properly formatted URI.
 class URL
   # @return [NSURL, URI::HTTP] the type depends on your RUBY_ENGINE
   attr_accessor :url

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Mark Rada
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-10 00:00:00 -05:00
+date: 2010-11-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,8 +40,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -77,16 +79,31 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- ChangeLog
 - LICENSE
 - README.markdown
 files: 
 - lib/jiraSOAP.rb
 - lib/jiraSOAP/JIRAservice.rb
+- lib/jiraSOAP/api.rb
+- lib/jiraSOAP/entities.rb
+- lib/jiraSOAP/entities/abstract.rb
+- lib/jiraSOAP/entities/attachments.rb
+- lib/jiraSOAP/entities/avatar.rb
+- lib/jiraSOAP/entities/comment.rb
+- lib/jiraSOAP/entities/field_value.rb
+- lib/jiraSOAP/entities/filter.rb
+- lib/jiraSOAP/entities/issue.rb
+- lib/jiraSOAP/entities/issue_properties.rb
+- lib/jiraSOAP/entities/project.rb
+- lib/jiraSOAP/entities/read_only.rb
+- lib/jiraSOAP/entities/schemes.rb
+- lib/jiraSOAP/entities/user.rb
+- lib/jiraSOAP/entities/version.rb
 - lib/jiraSOAP/handsoap_extensions.rb
-- lib/jiraSOAP/remoteAPI.rb
-- lib/jiraSOAP/remoteEntities.rb
+- lib/jiraSOAP/macruby_bonuses.rb
 - lib/jiraSOAP/url.rb
-- lib/macruby_stuff.rb
+- ChangeLog
 - LICENSE
 - README.markdown
 - test/jiraSOAP_test.rb
@@ -96,8 +113,8 @@ homepage: http://github.com/ferrous26/jiraSOAP
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement