xplanner 0.1.3 → 0.1.4

data/Gemfile

@@ -2,4 +2,9 @@ source :rubygems
 
 gem 'savon'
 gem 'nokogiri'
-gem 'activesupport'
+gem 'activesupport'
+
+group :test do
+  gem 'rspec'
+  gem 'uri'
+end

data/README.md

@@ -0,0 +1,23 @@
+# XPlanner+ Webservice Wrapper
+
+This gem provides a wrapper for manipulating [XPlanner+](http://xplanner-plus.sourceforge.net/) via the SOAP interface.
+
+There are models for Projects, Iterations, User Storys, Tasks and People.
+
+To get started, you need to provide a config hash to the XPlanner module, like so:
+
+```ruby
+config = {
+  :url => 'http://127.0.0.1:8080/xplanner-plus/'
+  :user => 'sysadmin'
+  :pass => 'admin'
+}
+
+XPlanner::setup( config )
+```
+
+Start creating XPlanner objects like so:
+
+```ruby
+@myProject = XPlanner::Project.create( 'delete me', 'delete me: test project' )
+```

data/lib/config/attr_accessor_dirty_bit.rb

@@ -4,10 +4,10 @@ module AttrAccessorWithDirtyBit
 
     names.each do |name|
       define_method :"#{name}=" do |v|
-      	if instance_variable_get(:"@#{name}") != v
-	      	@dirty_bit = true 
-	        instance_variable_set(:"@#{name}", v)
-	      end
+        if instance_variable_get(:"@#{name}") != v
+          @dirty_bit = true 
+          instance_variable_set(:"@#{name}", v)
+        end
       end
     end
   end

data/lib/config/default_config.rb

@@ -1,7 +1,7 @@
 module XPlanner
-	@@default_config = {
-			:xplanner_url => "http://192.168.237.1:8080/xplanner-plus/",
-			:username => 'sysadmin',
-			:password => 'admin'
-		}
+  @@default_config = {
+      :xplanner_url => "http://127.0.0.1:8080/xplanner-plus/",
+      :username => 'sysadmin',
+      :password => 'admin'
+    }
 end

data/lib/config/savon_config.rb

@@ -12,45 +12,45 @@ HTTPI.log = false
 
 # Helper for decoding multi-ref style SOAP responses
 module Savon
-	module SOAP
-		class Response
-			def decode_soap_response( path = [] )
-				hash = SoapResponseDecoder.decode( self.to_xml )
-				path.each { |p| hash = hash[p] }
-				hash
-			end
-		end
-	end
+  module SOAP
+    class Response
+      def decode_soap_response( path = [] )
+        hash = SoapResponseDecoder.decode( self.to_xml )
+        path.each { |p| hash = hash[p] }
+        hash
+      end
+    end
+  end
 end
 
 # Decode multi-ref soap references. 
 class SoapResponseDecoder
-	def self.decode( xml_doc )
-		doc = Nokogiri::XML xml_doc
-
-		while( el = doc.xpath('//soapenv:Body//*[@href]').first )
-			id = el.attribute('href').value.gsub('#', '')
-			el.children = doc.xpath("//soapenv:Body//multiRef[@id='#{id}']").children()
-			el.remove_attribute('href')
-		end
-
-		hash = convert_hash_keys( Hash.from_xml( doc.to_s ) )[:envelope][:body]
-	end
-
-
-	def self.underscore_key(k)
-	  k.to_s.underscore.to_sym
-	end
-
-	def self.convert_hash_keys(value)
-	  case value
-	    when Array
-	      value.map { |v| convert_hash_keys(v) }
-	    when Hash
-	      Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] if k != 'xsi:type' }]
-	    else
-	      value
-	   end
-	end
+  def self.decode( xml_doc )
+    doc = Nokogiri::XML xml_doc
+
+    while( el = doc.xpath('//soapenv:Body//*[@href]').first )
+      id = el.attribute('href').value.gsub('#', '')
+      el.children = doc.xpath("//soapenv:Body//multiRef[@id='#{id}']").children()
+      el.remove_attribute('href')
+    end
+
+    hash = convert_hash_keys( Hash.from_xml( doc.to_s ) )[:envelope][:body]
+  end
+
+
+  def self.underscore_key(k)
+    k.to_s.underscore.to_sym
+  end
+
+  def self.convert_hash_keys(value)
+    case value
+      when Array
+        value.map { |v| convert_hash_keys(v) }
+      when Hash
+        Hash[value.map { |k, v| [underscore_key(k), convert_hash_keys(v)] if k != 'xsi:type' }]
+      else
+        value
+     end
+  end
 
 end

data/lib/config/version.rb

@@ -1,3 +1,3 @@
 module XPlanner
-	VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/helpers/xplanner_soap_client.rb

@@ -1,23 +1,23 @@
 module XPlanner
-	class SoapClient
-	  def initialize( params )
-	  	@client = Savon.client do |wsdl, http|
-	  		wsdl.document = params[:wsdl]
-	  		http.auth.basic params[:username], params[:password]
-	  	end
-	  end
+  class SoapClient
+    def initialize( params )
+      @client = Savon.client do |wsdl, http|
+        wsdl.document = params[:wsdl]
+        http.auth.basic params[:username], params[:password]
+      end
+    end
 
-		def confirm_connection
-			begin
-				return @client.wsdl.soap_actions.include? :get_user_story
-			rescue
-				return false
-			end
-		end
+    def confirm_connection
+      begin
+        return @client.wsdl.soap_actions.include? :get_user_story
+      rescue
+        return false
+      end
+    end
 
-		# throws exception if xplanner doesn't like it.
-		def call( rpc, payload=nil)
-			@client.request( rpc ) { soap.body = payload unless payload.nil? }
-		end
-	end
+    # throws exception if xplanner doesn't like it.
+    def call( rpc, payload=nil)
+      @client.request( rpc ) { soap.body = payload unless payload.nil? }
+    end
+  end
 end

data/lib/models/iteration.rb

@@ -1,7 +1,7 @@
 module XPlanner
   class Iteration < ModelHelper
     extend AttrAccessorWithDirtyBit
-  	dirty_accessor  :name,
+    dirty_accessor  :name,
                     :description,
                     :project_id,
                     :status_key,
@@ -21,73 +21,73 @@ module XPlanner
                   :last_update_time
 
 
-  	def initialize( iter )
+    def initialize( iter )
       @dirty_bit = false
 
-  		@id                         = iter[:id]
-  		@name                       = iter[:name]
-  		@description                = iter[:description]
-  		@project_id                 = iter[:project_id]
-  		@status_key                 = iter[:status_key]
-  		@actual_hours               = iter[:actual_hours]
-  		@added_hours                = iter[:added_hours]
-  		@adjusted_estimated_hours   = iter[:adjusted_estimated_hours]
-  		@days_worked                = iter[:days_worked]
-  		@estimated_hours            = iter[:estimated_hours]
-  		@overestimated_hours        = iter[:overestimated_hours]
-  		@postponed_hours            = iter[:postponed_hours]
-  		@remaining_hours            = iter[:remaining_hours]
-  		@start_date                 = Iteration.parse_date iter[:start_date]
-  		@end_date                   = Iteration.parse_date iter[:end_date]
-  		@last_update_time           = Iteration.parse_date iter[:last_update_time]
-  		@underestimated_hours       = iter[:underestimated_hours]
-  	end
+      @id                         = iter[:id]
+      @name                       = iter[:name]
+      @description                = iter[:description]
+      @project_id                 = iter[:project_id]
+      @status_key                 = iter[:status_key]
+      @actual_hours               = iter[:actual_hours]
+      @added_hours                = iter[:added_hours]
+      @adjusted_estimated_hours   = iter[:adjusted_estimated_hours]
+      @days_worked                = iter[:days_worked]
+      @estimated_hours            = iter[:estimated_hours]
+      @overestimated_hours        = iter[:overestimated_hours]
+      @postponed_hours            = iter[:postponed_hours]
+      @remaining_hours            = iter[:remaining_hours]
+      @start_date                 = Iteration.parse_date iter[:start_date]
+      @end_date                   = Iteration.parse_date iter[:end_date]
+      @last_update_time           = Iteration.parse_date iter[:last_update_time]
+      @underestimated_hours       = iter[:underestimated_hours]
+    end
 
     def self.all( project_id )
-    	rpc = :get_iterations
-    	payload = { :projectId => project_id }
-    	path = [:get_iterations_response, :get_iterations_return, :get_iterations_return]
-    	fetch_from_remote( rpc, payload, path, Iteration )
+      rpc = :get_iterations
+      payload = { :projectId => project_id }
+      path = [:get_iterations_response, :get_iterations_return, :get_iterations_return]
+      fetch_from_remote( rpc, payload, path, Iteration )
     end
 
     def self.retrieve( iteration_id )
-    	rpc = :get_iteration
-    	payload = { :iterationId => iteration_id }
-    	path = [:get_iteration_response, :get_iteration_return]
-    	fetch_from_remote( rpc, payload, path, Iteration )
+      rpc = :get_iteration
+      payload = { :iterationId => iteration_id }
+      path = [:get_iteration_response, :get_iteration_return]
+      fetch_from_remote( rpc, payload, path, Iteration )
     end
 
     # needs status setting
-  	def self.create( project_id, name, description, start_date, end_date )
-    	rpc = :add_iteration
-    	payload = { 
-    		:iterationData => {
-    			:project_id => project_id, 
-    			:name => name, 
-    			:description => description, 
-    			:start_date => start_date, 
-    			:end_date => end_date,
+    def self.create( project_id, name, description, start_date, end_date )
+      rpc = :add_iteration
+      payload = { 
+        :iterationData => {
+          :project_id => project_id, 
+          :name => name, 
+          :description => description, 
+          :start_date => start_date, 
+          :end_date => end_date,
           :status_key => 'inactive'
-    		} 
-    	}
-    	path = [:add_iteration_response, :add_iteration_return]
-    	fetch_from_remote( rpc, payload, path, Iteration )
+        } 
+      }
+      path = [:add_iteration_response, :add_iteration_return]
+      fetch_from_remote( rpc, payload, path, Iteration )
     end
 
     def self.delete( id )
-    	rpc = :remove_iteration
-    	payload = { :id => id }
+      rpc = :remove_iteration
+      payload = { :id => id }
       remote_delete( rpc, payload )
     end
 
     def delete
-    	Iteration.delete( @id )
+      Iteration.delete( @id )
     end
 
     def save
-    	rpc = :update
-    	payload = { :iterationData => create_payload }
-  		remote_update( rpc, payload )
+      rpc = :update
+      payload = { :iterationData => create_payload }
+      remote_update( rpc, payload )
     end
 
   end

data/lib/models/person.rb

@@ -67,7 +67,7 @@ module XPlanner
     end
 
     def self.get_userid_from_username( username )
-        Person.all.each { |u| return Integer(u.id) if u.name == username }
+        Person.all.each { |u| return Integer(u.id) if u.user_id == username }
         return nil
     end
   end

data/lib/models/project.rb

@@ -10,45 +10,45 @@ module XPlanner
     def initialize( p )
       @dirty_bit = false
 
-    	@id                = p[:id]
-    	@name              = p[:name]
-    	@last_update_time  = Project.parse_date p[:last_update_time]
-    	@description       = p[:description]
+      @id                = p[:id]
+      @name              = p[:name]
+      @last_update_time  = Project.parse_date p[:last_update_time]
+      @description       = p[:description]
     end
 
     def self.all
-    	rpc = :get_projects
-    	path = [:get_projects_response, :get_projects_return, :get_projects_return]
-    	fetch_from_remote( rpc, {}, path, Project )
+      rpc = :get_projects
+      path = [:get_projects_response, :get_projects_return, :get_projects_return]
+      fetch_from_remote( rpc, {}, path, Project )
     end
 
     def self.retrieve( id )
-    	rpc = :get_project
-    	payload = { :id => id }
-    	path = [:get_project_response, :get_project_return]
+      rpc = :get_project
+      payload = { :id => id }
+      path = [:get_project_response, :get_project_return]
         fetch_from_remote( rpc, payload, path, Project )
     end
 
     def self.create( name, description )
-    	rpc = :add_project
-    	payload = { :projectData => { :name => name, :description => description } }
+      rpc = :add_project
+      payload = { :projectData => { :name => name, :description => description } }
         path = [:add_project_response, :add_project_return]
-    	fetch_from_remote( rpc, payload, path, Project )
+      fetch_from_remote( rpc, payload, path, Project )
     end
 
     def self.delete( id )
-    	rpc = :remove_project
-    	payload = { :id => id }
+      rpc = :remove_project
+      payload = { :id => id }
         remote_delete( rpc, payload )
     end
 
     def delete
-    	Project.delete @id
+      Project.delete @id
     end
 
     def save
-    	rpc = :update
-    	payload = { :projectData => create_payload }
+      rpc = :update
+      payload = { :projectData => create_payload }
         remote_update( rpc, payload )
     end
 

data/lib/models/story.rb

@@ -43,10 +43,10 @@ module XPlanner
     end
 
     def self.all( iteration_id )
-    	rpc = :get_user_stories
-    	payload = { :containerId => iteration_id }
-    	path = [:get_user_stories_response, :get_user_stories_return, :get_user_stories_return]
-    	fetch_from_remote( rpc, payload, path, Story )
+      rpc = :get_user_stories
+      payload = { :containerId => iteration_id }
+      path = [:get_user_stories_response, :get_user_stories_return, :get_user_stories_return]
+      fetch_from_remote( rpc, payload, path, Story )
     end
 
    def self.retrieve( story_id )

data/lib/models/task.rb

@@ -41,10 +41,10 @@ module XPlanner
     end
 
     def self.all( story_id )
-    	rpc = :get_tasks
-    	payload = { :containerId => story_id }
-    	path = [:get_taskss_response, :get_tasks_return, :get_tasks_return]
-    	fetch_from_remote( rpc, payload, path, Task )
+      rpc = :get_tasks
+      payload = { :containerId => story_id }
+      path = [:get_taskss_response, :get_tasks_return, :get_tasks_return]
+      fetch_from_remote( rpc, payload, path, Task )
     end
 
    def self.retrieve( task_id )

data/lib/xplanner.rb

@@ -2,33 +2,33 @@ project_root = File.expand_path('../', __FILE__)
 project_dirs = ['config', 'helpers', 'models']
 
 project_dirs.each do |d|
-	Dir.glob(project_root + '/' + d + '/*.rb') {|file| require file}
+  Dir.glob(project_root + '/' + d + '/*.rb') {|file| require file}
 end
 
 require 'uri'
 
 module XPlanner
-	def self.setup( config = {} )
-		url = config[:url] 		||= @@default_config[:xplanner_url]
-		user = config[:user] 	||= @@default_config[:username]
-		pass = config[:pass] 	||= @@default_config[:password]
+  def self.setup( config = {} )
+    url = config[:url]    ||= @@default_config[:xplanner_url]
+    user = config[:user]  ||= @@default_config[:username]
+    pass = config[:pass]  ||= @@default_config[:password]
 
-		wsdl = URI::join(url, 'soap/XPlanner?wsdl').to_s
+    wsdl = URI::join(url, 'soap/XPlanner?wsdl').to_s
 
-		client_config = {
-			:wsdl => wsdl,
-			:username => user,
-			:password => pass
-		}
+    client_config = {
+      :wsdl => wsdl,
+      :username => user,
+      :password => pass
+    }
 
-		soap_client = SoapClient.new( client_config )
-		ModelHelper.soap_client= soap_client
-		@@connection_successful = soap_client.confirm_connection
+    soap_client = SoapClient.new( client_config )
+    ModelHelper.soap_client= soap_client
+    @@connection_successful = soap_client.confirm_connection
 
-		ModelHelper.base_url= url
-	end
+    ModelHelper.base_url= url
+  end
 
-	def self.connection?
-		@@connection_successful
-	end
+  def self.connection?
+    @@connection_successful
+  end
 end

data/test/tests.rb

@@ -46,11 +46,7 @@ describe 'XPlanner+ SOAP interface' do
   describe 'Model: Iteration' do
     before(:all) do
       @myProject = XPlanner::Project.create( 'delete me', 'delete me: test project' )
-      @myIteration = XPlanner::Iteration.create(  @myProject.id, 
-                                        'delete me', 
-                                        'delete me: test iteration', 
-                                        DateTime.now, 
-                                        DateTime.now+5 )
+      @myIteration = XPlanner::Iteration.create( @myProject.id, 'delete me', 'delete me: test iteration', DateTime.now, DateTime.now+5 )
     end
 
     after(:all) do
@@ -90,11 +86,7 @@ describe 'XPlanner+ SOAP interface' do
   describe 'Model: User Story' do
     before(:all) do
       @myProject = XPlanner::Project.create( 'delete me', 'delete me: test project' )
-      @myIteration = XPlanner::Iteration.create(  @myProject.id, 
-                                        'delete me', 
-                                        'delete me: test iteration', 
-                                        DateTime.now, 
-                                        DateTime.now+5 )
+      @myIteration = XPlanner::Iteration.create( @myProject.id, 'delete me', 'delete me: test iteration', DateTime.now, DateTime.now+5 )
       @myStory = XPlanner::Story.create( @myIteration.id, 'delete me', 'delete me: test story')
     end
 
@@ -134,11 +126,7 @@ describe 'XPlanner+ SOAP interface' do
   describe 'Model: Task' do
     before(:all) do
       @myProject = XPlanner::Project.create( 'delete me', 'delete me: test project' )
-      @myIteration = XPlanner::Iteration.create(  @myProject.id, 
-                                        'delete me', 
-                                        'delete me: test iteration', 
-                                        DateTime.now, 
-                                        DateTime.now+5 )
+      @myIteration = XPlanner::Iteration.create( @myProject.id, 'delete me', 'delete me: test iteration', DateTime.now, DateTime.now+5 )
       @myStory = XPlanner::Story.create( @myIteration.id, 'delete me', 'delete me: test story')
       @myTask = XPlanner::Task.create( @myStory.id, 'delete me', 'delete me: test task')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xplanner
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
+date: 2013-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon