jiraSOAP 0.7.1 → 0.8.0

data/lib/jiraSOAP/entities/worklog.rb

@@ -0,0 +1,28 @@
+##
+# Contains the data and metadata for a remote worklog.
+class JIRA::Worklog < JIRA::DescribedEntity
+
+  # @return [String]
+  add_attribute :comment, 'comment', :content
+
+  ##
+  # @todo Why does this need to be a DateTime? It should be a Time object
+  #       so that it can be compatible with Cocoa's NSDate on MacRuby.
+  #
+  # Needs to be a DateTime.
+  #
+  # @return [DateTime]
+  add_attribute :start_data, 'startDate', :to_date
+
+  # @return [String]
+  add_attribute :time_spent, 'timeSpent', :content
+
+  # @param [Handsoap::XmlMason::Node] msg
+  # @return [Handsoap::XmlMason::Node]
+  def soapify_for msg
+    msg.add 'comment', @comment
+    msg.add 'startDate', @start_date
+    msg.add 'timeSpent', @time_spent
+  end
+
+end

data/lib/jiraSOAP/handsoap_extensions.rb

@@ -1,86 +1,37 @@
-# 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
-
-  # A node in a Nokogiri XML document.
-  class Node
-
-    # @todo Make this method recursive
-    # @param [String] node_name
-    # @param [Array] array
-    # @param [Hash] options
-    def add_simple_array(node_name, array = [], options = {})
-      prefix, name = parse_ns(node_name)
-      node = append_child Element.new(self, prefix, name, nil, options)
-      array.each { |element| node.add node_name, element }
-    end
-
-    # @todo Make this method recursive
-    # @param [String] node_name
-    # @param [Array] array
-    # @param [Hash] options
-    def add_complex_array(node_name, array = [], options = {})
-      prefix, name = parse_ns(node_name)
-      node = append_child Element.new(self, prefix, name, nil, options)
-      array.each { |element| element.soapify_for node, name }
-    end
-
+##
+# @todo Push these upstream?
+#
+# Some simple extensions to Handsoap to make building SOAP messages easier.
+class Handsoap::XmlMason::Node
+  ##
+  # @todo Make this method recursive
+  #
+  # @param [String] node_name
+  # @param [Array] array
+  # @param [Hash] options
+  def add_simple_array node_name, array = [], options = {}
+    prefix, name = parse_ns(node_name)
+    node = append_child Handsoap::XmlMason::Element.new(self, prefix, name, nil, options)
+    array.each { |element| node.add node_name, element }
   end
 
-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
-
-    # Parses non-strict date strings into Time objects.
-    # @return [Time]
-    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 [URI::HTTP,NSURL]
-    def to_url
-      temp = self.to_s
-      return unless temp
-      JIRA.url_class.send JIRA.url_init_method, temp
-    end
-
-    # Returns the node's children to an array of strings.
-    # @return [[String]]
-    def to_ss
-      children.map { |val| val.to_s }
-    end
-
-    # @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
-      children.map { |node| klass.new_with_xml node }
-    end
+  ##
+  # @todo Make this method recursive
+  #
+  # @param [String] node_name
+  # @param [Array] array
+  # @param [Hash] options
+  def add_complex_array node_name, array = [], options = {}
+    prefix, name = parse_ns(node_name)
+    node = append_child Handsoap::XmlMason::Element.new(self, prefix, name, nil, options)
+    array.each { |element| element.soapify_for node, name }
   end
 end
 
+##
+# Monkey patch to expose the underlying Nokogiri object as jiraSOAP
+# can parse much faster without the Handsoap layer in between.
+class Handsoap::XmlQueryFront::NokogiriDriver
+  # @return [Nokogiri::XML::Element]
+  attr_reader :element
 end

data/lib/jiraSOAP/{JIRAservice.rb → jira_service.rb}

@@ -1,20 +1,19 @@
-# @todo consider adding a finalizer that will try to logout
-# @note HTTPS is not supported in this version.
+##
+# @note HTTPS is not supported out of the box in this version.
+#
 # Interface to the JIRA endpoint server.
 #
 # Due to limitations in Handsoap::Service, there can only be one endpoint.
 # You can have multiple instances of that one endpoint if you would
-# like; but if you try to set a differnt endpoint for a new instance you
-# will end up messing up any other instances currently being used.
-#
-# It is best to treat this class as a singleton, but it is not enforced
-# in case you want to be able to login as multiple users to the same endpoint.
+# like (different users); but if you try to set a differnt endpoint for a
+# new instance you will end up messing up any other instances currently
+# being used.
 class JIRA::JIRAService < Handsoap::Service
   include JIRA::RemoteAPI
   include JIRA::RemoteAPIAdditions
 
   # @return [String]
-  attr_reader :auth_token
+  attr_accessor :auth_token
 
   # @return [String]
   attr_reader :user
@@ -22,7 +21,9 @@ class JIRA::JIRAService < Handsoap::Service
   # @return [String]
   attr_reader :endpoint_url
 
-  # Initialize and log in.
+  ##
+  # Initialize _and_ log in. Fancy.
+  #
   # @param [String,URL] url URL for the JIRA server
   # @param [String] user JIRA user name to login with
   # @param [String] password
@@ -33,16 +34,18 @@ class JIRA::JIRAService < Handsoap::Service
     jira
   end
 
-  # @param [String,URI::HTTP,NSURL] endpoint_url for the JIRA server
-  def initialize endpoint_url
-    @endpoint_url = endpoint_url.to_s
-    JIRA::JIRAService.endpoint({
-      uri:"#{endpoint_url.to_s}/rpc/soap/jirasoapservice-v2",
+  # @param [String,URI::HTTP,NSURL] endpoint for the JIRA server
+  def initialize endpoint
+    @endpoint_url = endpoint.to_s
+    self.class.endpoint({
+      uri:"#{endpoint_url}/rpc/soap/jirasoapservice-v2",
       version:2
     })
   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
@@ -55,11 +58,13 @@ class JIRA::JIRAService < Handsoap::Service
 
   protected
 
+  ##
   # Makes sure the correct namespace is set
   def on_create_document doc
     doc.alias 'soap', 'http://soap.rpc.jira.atlassian.com'
   end
 
+  ##
   # Make sure that the required namespace is added
   def on_response_document doc
     doc.add_namespace 'jir', @endpoint_url

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

@@ -1,23 +1,14 @@
-framework 'Foundation'
-
+##
 # 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
-    absoluteString
-  end
-
+  alias_method :to_s, :absoluteString
+  alias_method :inspect, :absoluteString
 end
 
-
-# @todo get a parallel map method for collections
 module JIRA
-
   @url_class       = NSURL
   @url_init_method = :'URLWithString:'
-
 end
+
+# @todo get a parallel map method for collections

data/lib/jiraSOAP/nokogiri_extensions.rb

@@ -0,0 +1,68 @@
+##
+# Monkey (Freedom) patches to Nokogiri
+class Nokogiri::XML::Element
+
+  # @return [Fixnum]
+  def to_i
+    content.to_i
+  end
+
+  # @return [Time,nil]
+  def to_iso_date
+    return if (temp = content).empty?
+    Time.iso8601 temp
+  end
+
+  ##
+  # Parses non-strict date strings into Time objects.
+  #
+  # @return [Time,nil]
+  def to_natural_date
+    return if (temp = content).empty?
+    Time.new temp
+  end
+
+  ##
+  # We assume that the boolean is encoded as as string, because that
+  # how JIRA is doing right now, but the XML schema allows a boolean
+  # to be encoded as 0/1 numbers instead.
+  #
+  # @return [Boolean]
+  def to_boolean
+    content == 'true' # || content == 1
+  end
+
+  # @return [URI::HTTP,NSURL,nil]
+  def to_url
+    return if (temp = content).empty?
+    JIRA.url_class.send JIRA.url_init_method, temp
+  end
+
+  ##
+  # This is a bit naive, but should be sufficient for its purpose.
+  #
+  # @return [Array(String,String,String),nil]
+  def to_color_triple
+    return if (temp = content).empty?
+    temp.match(/#(..)(..)(..)/).captures
+  end
+  alias_method :to_colour_triple, :to_color_triple
+
+  ##
+  # Ideally this method will return an array of strings, but this
+  # may not always be the case.
+  def contents_of_children
+    children.map { |val| val.content }
+  end
+
+  # @param [Class] klass the JIRA object you want to make
+  def children_as_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 children_as_objects klass
+    children.map { |node| klass.new_with_xml node }
+  end
+end

data/lib/jiraSOAP/url.rb

@@ -2,8 +2,16 @@ module JIRA
 
   class << self
 
-    # Normally this variable is set to URI, but with MacRuby it is
-    # set to NSURL
+    # 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
+    # URI::HTTP interchangeable. If you really want to, you can override
+    # the wrapper by changing {JIRA.url_class} and {JIRA.url_init_method}
+    # so that:
+    #
+    #     JIRA.url_class.send JIRA.url_init_method, 'http://marketcircle.com'
+    #
+    # will be working code.
     # @return [Class,Module]
     attr_accessor :url_class
 

data/lib/jiraSOAP/version.rb

@@ -0,0 +1,3 @@
+module JIRA
+  VERSION = '0.8.0'
+end

metadata

@@ -2,7 +2,7 @@
 name: jiraSOAP
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors: 
 - Mark Rada
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-13 00:00:00 -05:00
-default_executable: 
+date: 2011-06-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -36,25 +35,25 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: yard
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.8.7
+        version: 0.7.1
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: redcarpet
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.0.10
+        version: "1.15"
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -63,44 +62,11 @@ dependencies:
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.2
+        version: 2.2.2
   type: :development
   version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: reek
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.2.8
-  type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: yard
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.6.4
-  type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: bluecloth
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 2.0.10
-  type: :development
-  version_requirements: *id008
 description: Written to run fast and work on Ruby 1.9 as well as MacRuby
 email: 
 - mrada@marketcircle.com
@@ -109,10 +75,11 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README.markdown
 - ChangeLog
 - LICENSE.txt
-- README.markdown
 - .yardopts
+- docs/GettingStarted.markdown
 files: 
 - lib/jiraSOAP/api/additions.rb
 - lib/jiraSOAP/api/attachments.rb
@@ -127,7 +94,9 @@ files:
 - lib/jiraSOAP/api/server_info.rb
 - lib/jiraSOAP/api/users.rb
 - lib/jiraSOAP/api/versions.rb
+- lib/jiraSOAP/api/worklog.rb
 - lib/jiraSOAP/api.rb
+- lib/jiraSOAP/core_extensions.rb
 - lib/jiraSOAP/entities/attachment_metadata.rb
 - lib/jiraSOAP/entities/avatar.rb
 - lib/jiraSOAP/entities/comment.rb
@@ -158,25 +127,29 @@ files:
 - lib/jiraSOAP/entities/status.rb
 - lib/jiraSOAP/entities/time_info.rb
 - lib/jiraSOAP/entities/user.rb
+- lib/jiraSOAP/entities/usergroup.rb
 - lib/jiraSOAP/entities/username.rb
 - lib/jiraSOAP/entities/version.rb
+- lib/jiraSOAP/entities/worklog.rb
 - lib/jiraSOAP/entities.rb
 - lib/jiraSOAP/handsoap_extensions.rb
-- lib/jiraSOAP/JIRAservice.rb
-- lib/jiraSOAP/macruby_bonuses.rb
+- lib/jiraSOAP/jira_service.rb
+- lib/jiraSOAP/macruby_extensions.rb
+- lib/jiraSOAP/nokogiri_extensions.rb
 - lib/jiraSOAP/url.rb
+- lib/jiraSOAP/version.rb
 - lib/jiraSOAP.rb
-- yard-jiraSOAP.rb
+- test/jiraSOAP_test.rb
+- test/test_helper.rb
+- Rakefile
+- README.markdown
 - ChangeLog
 - LICENSE.txt
-- README.markdown
 - .yardopts
-- test/jiraSOAP_test.rb
-- test/test_helper.rb
-has_rdoc: true
+- docs/GettingStarted.markdown
 homepage: http://github.com/Marketcircle/jiraSOAP
 licenses: 
-- - MIT
+- MIT
 post_install_message: 
 rdoc_options: []
 
@@ -185,22 +158,23 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ~>
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.9.2
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.6
+      version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A Ruby client for the JIRA SOAP API
 test_files: 
 - test/jiraSOAP_test.rb
 - test/test_helper.rb
+- Rakefile