jirarest2 0.0.4 → 0.0.5

data/lib/services.rb

@@ -15,39 +15,34 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-require "connect"
-=begin
-  Trying to keep the services together in one class so I don't have to write so much
-=end
+require_relative "connect"
+
+#  Trying to keep the services together in one class so I don't have to write so much
 class Services
 
-=begin
-  We expect to receive an existing 
-  :connection
-=end
+  # @param [Connection]
   def initialize(connection)
     @connection = connection
 # to be set in each subclass;
 #    @uritail = ""
   end
 
-=begin
- Send the GET request
-=end
+  # Send the GET request
+  # @param [Hash] data to be sent to Connection.execute
   def get(data = "")
     return @connection.execute("Get",@uritail,data).result
   end
   
-=begin
- Send the POST request
-=end
+
+  # Send the POST request
+  # @param [Hash] data to be sent to Connection.execute
   def post(data = "")
     return @connection.execute("Post",@uritail,data)
   end  
 
-=begin
- Send the DELETE request
-=end
+  
+  # Send the DELETE request
+  # @param [Hash] data to be sent to Connection.execute
   def delete(data = "")
     return @connection.execute("Delete",@uritail,data)
   end

data/lib/services/issuelink.rb

@@ -21,10 +21,8 @@ require "issue"
 require "services/issuelinktype"
 require "exceptions"
 
-=begin
-  This class is responsible for the Linking of Issues
-  No real getter as of yet (I just didn't need it)
-=end
+#  This class is responsible for the Linking of Issues
+#  No real getter as of yet (I just didn't need it)
 class IssueLink < Services
 
   def initialize(connection)
@@ -33,9 +31,10 @@ class IssueLink < Services
   end
 
   private
-=begin
- return the issuekey
-=end
+
+  # return the issuekey regardless whether we got an Issue or just the Key
+  # @param [String, Issue] issue
+  # @return [String]
   def key(issue)
     if issue.instance_of?(Issue) then
       return issue.issuekey 
@@ -45,10 +44,14 @@ class IssueLink < Services
   end
   
   public
-=begin
- Links two issues
- Right now the visibility feature for comments is not supported
-=end
+
+  # Links two issues
+  # Right now the visibility feature for comments is not supported
+  # @param [String, Issue] thisIssue Issue to connect from
+  # @param [String, Issue] remoteIssue Issue to connect to
+  # @param [String] type Link type
+  # @param [String] comment If a comment should be set while linking
+  # @return [Jirarest2::Result] The result of the linking
   def link_issue(thisIssue,remoteIssue,type,comment = nil)
     inwardIssue = key(thisIssue)
     outwardIssue = key(remoteIssue)
@@ -80,9 +83,12 @@ class IssueLink < Services
     return post(json)
   end
 
-=begin
- Only true if successfully linked false if something happened. Elseway exactly as link_issue.
-=end
+  # does the linking ig you don't want to bother with the exact result
+  # @param [String, Issue] thisIssue Issue to connect from
+  # @param [String, Issue] remoteIssue Issue to connect to
+  # @param [String] type Link type
+  # @param [String] comment If a comment should be set while linking
+  # @return [Boolean] Only true if successfully linked false if something happened. Elseway exactly as link_issue.
   def link(thisIssue,remoteIssue,type,comment = nil)
     if link_issue(thisIssue,remoteIssue,type,comment).code == "201" then
       return true
@@ -90,5 +96,5 @@ class IssueLink < Services
       return false
     end
   end
-
+  
 end # class

data/lib/services/issuelinktype.rb

@@ -17,15 +17,13 @@
 
 require "services"
 
-=begin
-  An IssueLinkType Object represents one or all IssueLinkTypes
-=end
+#  An IssueLinkType Object represents one or all IssueLinkTypes
 class IssueLinkType < Services
 
-=begin
-  We expect to receive an existing 
-  :connection
-=end
+
+  # @param [Connection] connection
+  # @param [String] data issueLinkType ID 
+  # @return [Jirarest2::Result]
   def initialize(connection,data = "")
     if data == "" then
       @uritail = "issueLinkType"
@@ -37,9 +35,11 @@ class IssueLinkType < Services
   end
 
 private
-=begin
-  do the search for each block
-=end
+
+  # do the search for each block
+  # @param [Hash] hash One LinkIssueType in a hash representation
+  # @param [String] uiname the way the linktype is shown in the browser
+  # @return [Array] Actual name oft the LinkIssueType
   def name_block_search(hash,uiname)
     name = nil
     direction = nil
@@ -58,10 +58,10 @@ private
 
 
 public
-=begin
-  Get the internal name and direction instead of the one in the UI.
-  Returns an Array with the name and the direction ("inward" or "outward") if successfull , nil if not
-=end
+
+  #Get the internal name and direction instead of the one in the UI.
+  # @param [String] uiname the way the linktype is shown in the browser
+  # @return [Array, nil] Array with the name and the direction ("inward" or "outward") if successfull , nil if not
   def name(uiname)
     if @all["issueLinkTypes"].instance_of?(Array) then
       @all["issueLinkTypes"].each{ |hash|
@@ -74,9 +74,9 @@ public
     return nil # Nothing found don't want to return @all
   end # name
 
-=begin
-  Is the name realy the internal name we need to use?
-=end
+  # Is the name realy the internal name we need to use?
+  # @param [String] test String to test agains the names of IssueLinkTypes
+  # @return [Boolean] 
   def internal_name?(test)
     if @all["issueLinkTypes"].instance_of?(Array) then
       @all["issueLinkTypes"].each{ |hash|

data/lib/services/watcher.rb

@@ -18,22 +18,20 @@
 require "connect"
 require "services"
 
-=begin
-  Watchers do have their own calling
-=end
+#  Watchers do have their own calling
 class Watcher < Services
 
-=begin
-  Set our uritail
-=end
+  #  Set our uritail
+  # @param [Connection] connection 
+  # @param [String] issueid The id or key of the issue in question
   def initialize(connection, issueid)
     @uritail = "issue/#{issueid}/watchers"
     super(connection)
   end
 
-=begin
- Return all the watchers of the issue
-=end
+
+  # Return all the watchers of the issue
+  # @return [String] Usernames of watching users
   def get_watchers
     ret = get
     watchers = Array.new
@@ -43,9 +41,10 @@ class Watcher < Services
     return watchers
   end
   
-=begin
-  Adds a new watcher for the issue
-=end
+
+  # Adds a new watcher for the issue
+  # @param [String] username Username of the new watcher
+  # @return [Boolean] Success
   def add_watcher(username)
     ret = post(username)
     case ret.code
@@ -56,9 +55,10 @@ class Watcher < Services
     end
   end
 
-=begin
-  removes one watcher from the issue
-=end
+
+  # remove one watcher from the issue
+  # @param [String] username Username of the watcher to delete
+  # @return [Boolean] Success
   def remove_watcher(username)
     query = {"username" => username}
     ret = delete(query)

data/test/data/test.config.data

@@ -0,0 +1,3 @@
+username = UsErNaMe
+password =  pAsSw0rD;
+URL = https://jira.localhost:2990/jira

data/test/test_madbitconfig.rb

@@ -0,0 +1,33 @@
+require "minitest/autorun"
+require "madbitconfig"
+require "pp"
+
+class TestConfig < MiniTest::Unit::TestCase
+
+  def test_read_configfile
+    testdir =  File.dirname($0)
+    testfile = testdir + "/test/data/test.config.data"
+    # Should work
+    testdata = {"username"=>"UsErNaMe", "password"=>"pAsSw0rD;", "URL"=>"https://jira.localhost:2990/jira"}
+    assert_equal testdata,MadbitConfig::read_configfile(testfile)
+    # And fail
+    assert_raises(IOError) { MadbitConfig::read_configfile(testfile+"blah") }
+  end
+
+  def test_write_configfile
+    testdir =  File.dirname($0)
+    testfile = testdir + "/test/data/test.config.tmp"
+    #make sure
+    File.delete(testfile) if File.exists?(testfile) 
+    #test
+    confighash = {"Param1" => "Value1", "Parameter 2" => "Value 2", "password" => " pAsSw0rD;21"}
+    assert_equal confighash,MadbitConfig::write_configfile(testfile,confighash)
+    assert_raises(MadbitConfig::FileExistsException) { MadbitConfig::write_configfile(testfile,confighash) }
+    assert_equal confighash,MadbitConfig::write_configfile(testfile,confighash,:force)
+    # cleanup
+    File.delete(testfile) if File.exists?(testfile)
+    
+  end
+
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirarest2
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -50,7 +50,7 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -84,6 +84,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: hoe-yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -100,18 +116,12 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.9.4
-description: ! "jirarest2 is yet another implementation of the JIRA(tm) REST-API[https://developer.atlassian.com/display/JIRADEV/JIRA+Remote+API+Reference]
-  .  This one for Ruby1.9.1\n\nIt is intended to be called within the shell to create
-  and verify JIRA(tm) issues fast without a browser. There was no particular need
-  for perfomance at the time of writing.\n\nThis implementation is still a for cry
-  from others like http://rubygems.org/gems/jira-ruby which required oauth authentification.
-  \n\nThe script allows you to create new issues with watchers and link those to existing
-  issues\n\n *Use it at your own risk. Most of the API features are not implemented.*\n\n
-  *Ruby1.9.1 is needed. Ruby1.8 doesn't work!*"
+description: ''
 email:
 - cebit-jirarest@gunnet.de
 executables:
 - create_issue.rb
+- jira_create_issue.rb
 extensions: []
 extra_rdoc_files:
 - History.txt
@@ -126,33 +136,36 @@ files:
 - README.txt
 - Rakefile
 - bin/create_issue.rb
+- bin/jira_create_issue.rb
 - copyright
-- lib/config.rb
 - lib/connect.rb
 - lib/credentials.rb
 - lib/exceptions.rb
 - lib/issue.rb
-- lib/issuelink.rb
 - lib/jirarest2.rb
 - lib/jirarest2/result.rb
+- lib/madbitconfig.rb
 - lib/services.rb
 - lib/services/issuelink.rb
 - lib/services/issuelinktype.rb
 - lib/services/watcher.rb
+- test/data/test.config.data
 - test/test_connect.rb
 - test/test_credentials.rb
 - test/test_issue.rb
 - test/test_issuelink.rb
 - test/test_issuelinktype.rb
+- test/test_madbitconfig.rb
 - test/test_result.rb
 - test/test_watcher.rb
 - .gemtest
-homepage: https://github.com/cybit/jirarest2#readme
+homepage: 
 licenses: []
 post_install_message: 
 rdoc_options:
-- --main
-- README.txt
+- --title
+- Jirarest2 Documentation
+- --quiet
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -172,8 +185,9 @@ rubyforge_project: jirarest2
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: jirarest2 is yet another implementation of the JIRA(tm) REST-API[https://developer.atlassian.com/display/JIRADEV/JIRA+Remote+API+Reference]
+summary: ''
 test_files:
+- test/test_madbitconfig.rb
 - test/test_connect.rb
 - test/test_issuelinktype.rb
 - test/test_credentials.rb

data/lib/config.rb

@@ -1,55 +0,0 @@
-# Module to handle configuration files
-#    Copyright (C) 2012 Cyril Bitterich
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published by
-#    the Free Software Foundation, either version 3 of the License, or
-#    (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU General Public License for more details.
-#
-#    You should have received a copy of the GNU General Public License
-#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-
-=begin
- Module to handle configuration files
-=end
-module Config
-=begin
- Inspired by http://www.erickcantwell.com/2011/01/simple-configuration-file-reading-with-ruby/
- reads a config-file and returns a hash
-=end
-  def self.read_configfile(config_file)
-    config_file = File.expand_path(config_file)
-
-    unless File.exists?(config_file) then
-      raise "Unable to find config file"
-    end
-    
-    regexp = Regexp.new(/\s+|"|\[|\]/)
-    
-    temp = Array.new
-    vars = Hash.new
-    
-    IO.foreach(config_file) { |line|
-      if line.match(/^\s*#/) #  don't care about lines starting with an # (even after whitespace)
-        next
-      elsif line.match(/^\s*$/) # no text, no content
-        next
-      else
-# Right now I don't know what to use scan for. It will escape " nice enough. But once that is excaped the regexp doesn't work any longer.
-#        temp[0],temp[1] = line.to_s.scan(/^.*$/).to_s.split("=")
-        temp[0],temp[1] = line.to_s.split("=")
-        temp.collect! { |val|
-          val.gsub(regexp, "")
-        }
-        vars[temp[0]] = temp[1]
-      end
-    }
-    return vars
-  end
-end