ruby_teamsite 0.4.7

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby_teamsite.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Bryan A. Crossland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,102 @@
+= Ruby TeamSite
+
+Ruby TeamSite is a gem library for interfacing with Autonomy Interwoven TeamSite 
+that is normal done through TeamSite Perl Modules or TeamSite Command Line Tools.
+You will need a licensed copy of Autonomy Interwoven TeamSite in order to use this gem.
+
+This gem is currently under development. Not all methods availible in the TeamSite Perl Modules
+or TeamSite Command Line Tools have been built in but will be in future releases. If you have any issues
+or questions about this gem please post them to the Issues section of this gem gitHub page: 
+https://github.com/bacrossland/ruby_teamsite
+
+== TeamSite Versions
+
+Ruby TeamSite has been written only for version 6.7.1 SP1 and greater of TeamSite on Linux and Solaris servers. 
+Windows is not supported at this time (manly because I don't have access to a version on Windows).
+
+== Ruby and Ruby on Rails Versions
+
+Ruby TeamSite will work with Ruby 1.8.7 and greater as well as Rails 2.3.* and Rails 3.0.* and greater.
+
+== Installing Ruby TeamSite
+
+To install Ruby TeamSite run the following gem command.
+
+	gem install ruby_teamsite
+
+== Documentation
+
+Documentation in rdoc form will be added to the next and subsequent releases.
+
+== Examples of Use
+
+To use this gem you must require it and then create a new object of either TeamSite, WFworkflow, or WFtask.
+WFworkflow and WFtask require a valid TeamSite job id and task id respectively to work. You can not create a blank
+workflow or task by just calling new (this may change in the future). Unlike the TeamSite Perl Modules there is not need to
+refresh or recreate the workflow or task object after executing a method that modifies them (ex: add_file). The results are
+available immediately. For example, if you add or remove files from a task you can then run the files method and see the result.  
+	
+	require 'ruby_teamsite'
+	
+	ts = RubyTeamSite::TeamSite.new
+		
+	ts.iwhome # Return the location that TeamSite is installed in.
+	ts.version # Return the TeamSite version.
+	ts.lock(file_path,comment,[ownerid]) # Have TeamSite lock a file. Comment is required but sending a blank is acceptable.
+	ts.unlock(file_path) # Have TeamSite unlock a file.
+	ts.file_state(file_path) # Return file state in a hash.
+	
+	wf = RubyTeamSite::WFworkflow.new(job_id)
+	
+	wf.name # Return the name of the workflow.
+	wf.id # Return the id of the workflow.
+	wf.creator # Return the name of the workflow creator.
+	wf.owner # Return the name of the workflow owner.
+	wf.description # Return the description of the workflow.
+	wf.xml # Return the XML output of the workflow.
+	wf.variables # Return a hash of variables for this workflow. The key is the name of the variable and the value is its value.
+	
+	task = RubyTeamSite::WFtask.new(task_id)
+	
+	task.name # Return the name of the task.
+	task.id # Return the id of the task.
+	task.type # Return the type of the task.
+	task.xml # Return the XML output of the task.
+	task.areavpath # Return the areavpath of the task.
+	task.callback # Callback to the workflow system to transition an external or cgi task.
+	task.success([msg]) # Callback with success to the workflow system to transition an external or cgi task to it's success successor. Message for transition is optional.
+	task.failure([msg]) # Callback with failure to the workflow system to transition an external or cgi task to it's failure successor. Message for transition is optional.
+	task.add_file(file_path,comment) # Add a file to the task. Comment is required but sending a blank is acceptable.
+	task.remove_file(file_path) # Remove a file to the task.
+	task.files # Return an array of files attached to this task.
+	
+== Additional Required Libraries
+
+Ruby TeamSite relies on Nokogiri for parsing XML of workflows. If you do not have Nokogiri installed it should install
+when you install Ruby TeamSite. Ruby TeamSite uses Nokogiri 1.4.4 or greater. You can learn more about Nokogiri here:
+http://nokogiri.org/
+
+
+== License
+
+Ruby TeamSite is released under the MIT license. A copy of it is provided in the LICENSE.txt file and below.
+
+Copyright (C) 2011 by Bryan A. Crossland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/ruby_teamsite.rb

@@ -0,0 +1,7 @@
+require 'ruby_teamsite/teamsite.rb'
+require 'ruby_teamsite/wfworkflow.rb'
+require 'ruby_teamsite/wftask.rb'
+
+module RubyTeamSite
+  
+end

data/lib/ruby_teamsite/teamsite.rb

@@ -0,0 +1,59 @@
+module RubyTeamSite
+  class TeamSite
+  
+    # Initialize the TeamSite class.
+    def initialize
+      @iw_home = `iwgethome 2>&1`
+      @ts_bin = ts_bin
+      @ts_ver = `#{@ts_bin}/iwversion 2>&1`
+    end  
+    
+    # Return the location that TeamSite is installed in.
+    def iwhome
+      return @iw_home
+    end
+    
+    # Return the TeamSite version.
+    def version
+      return @ts_ver
+    end
+    
+    # Have TeamSite lock a file. Comment is required but sending a blank is acceptable.
+    def lock(f,comment,ownerid=nil)
+      file_lock = `#{@ts_bin}/iwlock #{f} "#{comment}" #{ownerid unless ownerid.nil?} 2>&1`
+      return file_lock
+    end
+    
+    # Have TeamSite unlock a file.
+    def unlock(f)
+      file_lock = `#{@ts_bin}/iwunlock #{f} 2>&1`
+      return file_lock
+    end
+    
+    # Return file state in a hash.
+    def file_state(f)
+      fstate = `#{ts_bin}/iwfilestate -f script #{f} 2>&1`
+      if fstate.include?(':')
+        fstate.gsub!(/\n/,'')
+        tmp_arr = ['error',fstate]
+        fstate_hash = Hash[*tmp_arr.flatten]
+      else
+        fstate.gsub!(/\n/,':-:')
+        fstate.gsub!('=',':-:')
+        fstate_arr = fstate.split(":-:")
+        fstate_hash = Hash[*fstate_arr.flatten]
+      end
+      
+      return fstate_hash
+    end
+    private
+    
+    # Create the location to the bin directory for TeamSite.
+    def ts_bin
+      ts_bin = iwhome + '/bin'
+      ts_bin.gsub!(/\n/,'')
+      ts_bin.strip!
+      return ts_bin
+    end
+  end
+end

data/lib/ruby_teamsite/version.rb

@@ -0,0 +1,3 @@
+module RubyTeamSite
+  VERSION = "0.4.7"
+end

data/lib/ruby_teamsite/wftask.rb

@@ -0,0 +1,128 @@
+begin  
+  require "nokogiri"
+rescue LoadError  
+  # Nokogiri is unavailable.  
+  raise LoadError, "ERROR: Ruby TeamSite could not load nokogiri library. Please install nokogiri gem."
+end
+
+module RubyTeamSite
+  class WFtask
+  
+    # Initialize the WFtask class by getting the task from the workflow system by ID.
+    def initialize(task_id)
+      @task_id = task_id.strip
+      @ts_bin = ts_bin
+      @task = `#{@ts_bin}/iwgetwfobj #{task_id.strip}`
+      set_task_info(@task)
+    end
+  
+    # Return the name of the task.
+    def name
+      return @task_name 
+    end
+    
+    # Return the type of the task.
+    def type
+      return @task_type
+    end
+    
+    # Return the id of the task.
+    def id
+      return @task_id 
+    end
+    
+    # Return the XML output of the task.
+    def xml
+      return @task
+    end
+    
+    # Return the areavpath of the task.
+    def areavpath
+      return @areavpath
+    end
+    
+    # Callback to the workflow system to transition an external or cgi task.
+    def callback(trans_num, comment=nil)
+      # Only do a callback if the task is a cgitask or an externaltask.
+      cb = ""
+      if @task_type == 'cgitask' || @task_type == 'externaltask'
+        cb = `#{@ts_bin}/iwcallback #{@task_id} #{trans_num} "#{comment}" 2>&1`
+      end
+      return cb
+    end
+    
+    # Callback with success to the workflow system to transition an external or cgi task to it's success successor.
+    def success(msg=nil)
+      callback(0,msg)
+    end
+    
+    # Callback with failure to the workflow system to transition an external or cgi task to it's failure successor.
+    def failure(msg=nil)
+      callback(1,msg)
+    end
+    
+    # Add a file to the task. Comment is required but sending a blank is acceptable.
+    def add_file(f,comment)
+      file_path = "/#{f}"
+      addfile = `#{@ts_bin}/iwaddtaskfile #{@task_id} #{file_path} "#{comment}" 2>&1`
+      refresh
+      return addfile
+    end
+    
+    # Remove a file to the task.
+    def remove_file(f)
+      file_path = "/#{f}"
+      rmfile = `#{@ts_bin}/iwrmtaskfile #{@task_id} #{file_path} 2>&1`
+      refresh
+      return rmfile
+    end
+    
+    # Return an array of files attached to this task. 
+    def files
+      tsk = Nokogiri::XML(@task, nil, 'UTF-8')
+      elmnt_files = tsk.css('files file')
+      files = []
+      if elmnt_files.empty? == false
+        elmnt_files.each {|f| files << f.attribute('path').to_s}
+      end
+      return files
+    end
+    
+    private
+    
+    # Create the location to the bin directory for TeamSite.
+    def ts_bin
+      iwhome = `iwgethome`
+      ts_bin = iwhome + '/bin'
+      ts_bin.gsub!(/\n/,'')
+      ts_bin.strip!
+      return ts_bin
+    end
+    
+    # Set the information for the task.
+    def set_task_info(task)
+      tsk = Nokogiri::XML(task, nil, 'UTF-8')
+      
+      # Task name
+      task_name = tsk.root.attribute('name')
+      tname = task_name.to_s
+      @task_name = tname.strip
+      
+      # Task type
+      task_type = tsk.root.node_name
+      ttype = task_type.to_s
+      @task_type = ttype.strip
+      
+      # Task areavpath
+      areavpath = tsk.css('areavpath').attribute('v')
+      avp = areavpath.to_s
+      @areavpath = avp.strip
+    end
+    
+    # Refreshes the task variables to be current with what the workflow system has
+    def refresh
+      @task = `#{@ts_bin}/iwgetwfobj #{@task_id}`
+      set_task_info(@task)
+    end
+  end
+end

data/lib/ruby_teamsite/wfworkflow.rb

@@ -0,0 +1,97 @@
+begin  
+  require "nokogiri"
+rescue LoadError  
+  # Nokogiri is unavailable.  
+  raise LoadError, "ERROR: Ruby TeamSite could not load nokogiri library. Please install nokogiri gem."
+end
+
+module RubyTeamSite
+  class WFworkflow
+    
+    # Initialize the WFworkflow class by getting the workflow from the workflow system by ID.
+    def initialize(wf_id)
+      @workflow_id = wf_id.strip
+      @ts_bin = ts_bin
+      @workflow = `#{@ts_bin}/iwgetwfobj #{wf_id.strip}`
+      set_wf_info(@workflow)
+    end
+  
+    # Return the name of the workflow.
+    def name
+      return @wf_name 
+    end
+    
+    # Return the id of the workflow.
+    def id
+      return @workflow_id 
+    end
+    
+    # Return the name of the workflow creator.
+    def creator
+      return @wf_creator 
+    end
+    
+    # Return the name of the workflow owner.
+    def owner
+      return @wf_owner 
+    end
+    
+    # Return the description of the workflow.
+    def description
+      return @wf_desc 
+    end  
+    
+    # Return the XML output of the workflow.
+    def xml
+      return @workflow 
+    end
+    
+    # Return a hash of variables for this workflow. The key is the name of the variable and the value is its value.
+    def variables
+      wf = Nokogiri::XML(@workflow, nil, 'UTF-8')
+      elmnt_vars = wf.css('variables variable')
+      wf_vars = Hash.new
+      if elmnt_vars.empty? == false
+        elmnt_vars.each {|v| wf_vars[v.attribute('key').to_s] = v.attribute('value').to_s}
+      end
+      return wf_vars
+    end
+    
+    private
+    
+    # Create the location to the bin directory for TeamSite.
+    def ts_bin
+      iwhome = `iwgethome`
+      ts_bin = iwhome + '/bin'
+      ts_bin.gsub!(/\n/,'')
+      ts_bin.strip!
+      return ts_bin
+    end
+    
+    # Set the information for the workflow.
+    def set_wf_info(wf)
+      workflow = Nokogiri::XML(wf, nil, 'UTF-8')
+      
+      # Workflow name
+      wfname = workflow.root.attribute('name')
+      wfn = wfname.to_s
+      @wf_name = wfn.strip
+       
+      # Workflow owner
+      wfowner = workflow.root.attribute('owner')
+      wfo = wfowner.to_s
+      @wf_owner = wfo.strip
+      
+      # Workflow creator
+      wfcreator = workflow.root.attribute('creator')
+      wfc = wfcreator.to_s
+      @wf_creator = wfc.strip
+      
+      # Workflow description
+      wfdesc = workflow.css('description').text
+      wfd = wfdesc.to_s
+      @wf_desc = wfd.strip
+      
+    end
+  end
+end

data/ruby_teamsite.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby_teamsite/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ruby_teamsite"
+  s.version     = RubyTeamSite::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bryan A. Crossland"]
+  s.email       = ["bacrossland@gmail.com"]
+  s.homepage    = "https://github.com/bacrossland/ruby_teamsite"
+  s.summary     = %q{Ruby Gem for accessing and using Autonomy Interwoven TeamSite}
+  s.description = %q{This Ruby Gem gives Ruby access to Autonomy Interwoven TeamSite actions normally found in TeamSite Perl Modules or TeamSite CLTs.}
+
+  s.rubyforge_project = "ruby_teamsite"
+  s.license = 'MIT'
+
+  s.files         = Dir.glob("**/**/**")
+  s.require_paths = ["lib"]
+  s.add_dependency('nokogiri','>= 1.4.4')
+
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: ruby_teamsite
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 7
+  version: 0.4.7
+platform: ruby
+authors: 
+- Bryan A. Crossland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-18 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id001
+description: This Ruby Gem gives Ruby access to Autonomy Interwoven TeamSite actions normally found in TeamSite Perl Modules or TeamSite CLTs.
+email: 
+- bacrossland@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- lib/ruby_teamsite/teamsite.rb
+- lib/ruby_teamsite/version.rb
+- lib/ruby_teamsite/wftask.rb
+- lib/ruby_teamsite/wfworkflow.rb
+- lib/ruby_teamsite.rb
+- LICENSE.txt
+- Rakefile
+- README
+- ruby_teamsite.gemspec
+has_rdoc: true
+homepage: https://github.com/bacrossland/ruby_teamsite
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ruby_teamsite
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby Gem for accessing and using Autonomy Interwoven TeamSite
+test_files: []
+