brightspark3-rira 0.0.3

data/README.rdoc

@@ -0,0 +1,9 @@
+Rira
+====
+
+Rira is a ruby gem for interfacing Jira. Check out the Jira documentation for the {origin of the name}[http://confluence.atlassian.com/pages/viewpage.action?pageId=192544].
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 László Bácsi. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 3
+:major: 0
+:minor: 0

data/lib/rira/base.rb

@@ -0,0 +1,85 @@
+module Rira
+  class Base
+    def initialize(url, username, password, options = {})
+      @url, @username, @password = url, username, password
+      @token = xmlrpc_client.call("jira1.login", @username, @password)
+    rescue XMLRPC::FaultException => e
+      raise RPCError.new(e)
+    end
+
+    def xmlrpc_client
+      XMLRPC::Client.new2(@url)
+    end
+
+    MAPPINGS = {
+      :projects => ['project', "getProjectsNoSchemes", "getProjects"],
+      :projects_no_schemes => ['project', "getProjectsNoSchemes", "getProjects"],
+      :components => ['component', "getComponents"],
+      :versions => ['version', "getVersions"],
+      :issue_types => ['issue_type', "getIssueTypes"],
+      :issue_types_for_project => ['issue_type', "getIssueTypesForProject"],
+      :sub_task_issue_types => ['issue_type', "getSubTaskIssueTypes"],
+      :sub_task_issue_types_for_project => ['issue_type', "getSubTaskIssueTypesForProject"],
+      :create_issue => ['issue', "createIssue"],
+      :update_issue => ['issue', "updateIssue"],
+      :issue => ['issue', "getIssue"],
+      :issues_from_filter => ['issue', "getIssuesFromFilter"],
+      :search => ['issue', "getIssuesFromTextSearch"],
+      :search_with_project => ['issue', "getIssuesFromTextSearchWithProject"],
+      :add_comment => [nil, "addComment"],
+      :comments => ['comment', "getComments"],
+      :priorities => ['priority', "getPriorities"],
+      :resolutions => ['resolution', "getResolutions"],
+      :statuses => ['status', "getStatuses"],
+      :favourite_filters => ['filter', "getFavouriteFilters"],
+      :saved_filters => ['filter', "getSavedFilters"],
+      :server_info => ['server_info', "getServerInfo"],
+      :user => ['user', "getUser"],
+      :logout => [nil, "logout"],
+    }
+
+    def method_missing(method, *args)
+      model, *methods = MAPPINGS[method]
+
+      super(method, *args) if methods.empty?
+
+      retried = false
+      begin
+        case result = xmlrpc_client.call("jira1.#{methods.first}", @token, *args)
+        when Hash
+          model_or_struct(model, result)
+        when Array
+          result.map do |item|
+            if item.is_a?(Hash)
+              model_or_struct(model, item)
+            else
+              item
+            end
+          end
+        else
+          result
+        end
+      rescue XMLRPC::FaultException => e
+        if e.faultString =~ /session timed out/ and not retried
+          @token = xmlrpc_client.call("jira1.login", @username, @password)
+          retried = true
+          retry
+        else
+          methods.shift
+          retry unless methods.empty?
+          raise RPCError.new(e)
+        end
+      end
+    end
+
+    private
+
+      def model_or_struct(model, result)
+        if model
+          Model.new(self, model, result)
+        else
+          OpenStruct.new(result)
+        end
+      end
+  end
+end

data/lib/rira/model.rb

@@ -0,0 +1,95 @@
+require 'time'
+
+module Rira
+  class Model
+    ASSOCIATIONS = {
+      "add_comment"   => ["issue", "key"],
+      "comments"      => ["issue", "key"],
+      "components"    => ["project", "key"],
+      "issues"        => ["filter", "id",
+                          "issues_from_filter"],
+      "search"        => ["project", "keys",
+                          "search_with_project"],
+      "issue_types"   => ["project", "id", "issue_types_for_project"],
+      "sub_task_issue_types"  => ["project", "id",
+                                  "sub_task_issue_types_for_project"],
+      "versions"      => ["project", "key"],
+      "update"        => ["issue", "key",
+                          "update_issue"],
+    }
+
+    # FIXME: DRY this up a little bit
+    CONVERTERS = {
+      'resolution' => lambda {|s,x| s.base.resolutions.detect {|r| r.id == x}},
+      'priority'   => lambda {|s,x| s.base.priorities.detect {|p| p.id == x}},
+      'status'     => lambda {|s,x| s.base.statuses.detect {|p| p.id == x}},
+      'project'    => lambda {|s,x| s.base.projects.detect {|p| p.key == x}},
+      'type'       => lambda { |s,x|
+        p = s.project
+        (p.issue_types + p.sub_task_issue_types).detect {|it| it.id == x}
+      },
+      'lead' => lambda {|s,x| s.base.user(x)},
+      'author' => lambda {|s,x| s.base.user(x)},
+      'reporter' => lambda {|s,x| s.base.user(x)},
+      'assignee' => lambda {|s,x| s.base.user(x)},
+      'components' => lambda {|s,x| x.map {|c| Model.new(s.base, 'component', c)}},
+      'affects_versions' => lambda {|s,x| x.map {|v| Model.new(s.base, 'version', v)}},
+      'fix_versions' => lambda {|s,x| x.map {|v| Model.new(s.base, 'version', v)}},
+      'created' => lambda {|s,x| Time.parse(x)},
+      'updated' => lambda {|s,x| Time.parse(x)},
+      'release_date' => lambda {|s,x| Date.parse(x)},
+      'build_date' => lambda {|s,x| Date.parse(x)},
+      'archived' => lambda {|s,x| x == 'true'},
+      'released' => lambda {|s,x| x == 'true'},
+      'sub_task' => lambda {|s,x| x == 'true'},
+    }
+
+    BOOLEANS = %w{archived released sub_task}
+
+    attr_reader :base, :model
+
+    def initialize(base, model, hash)
+      @base, @model, @attributes = base, model, hash
+      @attributes.keys.each do |key|
+        new_key = key.gsub(/[A-Z]/) {"_#{$&.downcase}"}
+        if key != new_key
+          @attributes[new_key] = @attributes.delete(key)
+        end
+      end
+    end
+
+    def id
+      @attributes['id']
+    end
+
+    def type
+      CONVERTERS['type'].call(self, @attributes['type'])
+    end
+
+    def respond_to?(method)
+      @attributes.include? method.to_s
+    end
+
+    def method_missing(method, *args)
+      method = method.to_s
+      if method[-1] == ?? and BOOLEANS.include?(method[0..-2])
+        method = method[0..-2]
+      end
+      if args.empty? and @attributes.has_key?(method)
+        att = @attributes[method]
+        if converter = CONVERTERS[method]
+          converter.call(self, att)
+        else
+          att
+        end
+      elsif map = ASSOCIATIONS[method] and map.first == @model
+        _, att, rp = map
+        scope = att[-1] == ?s ? Array(@attributes[att[0..-2]]) : @attributes[att]
+        args.unshift(scope)
+        @base.send(rp || method, *args)
+      else
+        super(method.to_sym, *args)
+      end
+    end
+  end
+end

data/lib/rira.rb

@@ -0,0 +1,31 @@
+require 'xmlrpc/client'
+require 'ostruct'
+
+require File.join(File.dirname(__FILE__), 'rira', 'model')
+require File.join(File.dirname(__FILE__), 'rira', 'base')
+
+def Rira(url)
+  unless url =~ %r{/rpc/xmlrpc$}
+    url += '/' unless url[-1] == ?/
+    url += 'rpc/xmlrpc'
+  end
+  Rira::Client.new(url)
+end
+
+module Rira
+  class RPCError < StandardError
+    def initialize(fault_exception)
+      super("#{fault_exception.faultCode}: #{fault_exception.faultString}")
+    end
+  end
+
+  class Client
+    def initialize(url)
+      @url = url
+    end
+
+    def login(username, password)
+      Rira::Base.new(@url, username, password)
+    end
+  end
+end

data/test/rira_test.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class RiraTest < Test::Unit::TestCase
+  JIRA_URL = "http://jira.lackac.hu"
+  JIRA_USER = "rubi"
+  JIRA_PASS = "j1r4b0t"
+
+  context "A Rira Client" do
+    should "be able to login with correct password" do
+      rira = Rira(JIRA_URL + "/rpc/xmlrpc")
+      assert_nothing_raised do
+        rira = rira.login(JIRA_USER, JIRA_PASS)
+      end
+      assert rira.instance_variable_get('@token').length > 0
+    end
+
+    should "be created with the short URL (without /rpc/xmlrpc)" do
+      rira = Rira(JIRA_URL)
+      assert_nothing_raised { rira.login(JIRA_USER, JIRA_PASS) }
+    end
+
+    should "not get token with wrong password" do
+      rira = Rira(JIRA_URL)
+      assert_raise(Rira::RPCError) { rira.login("wrong", "authentication") }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rira'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: brightspark3-rira
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- "L\xC3\xA1szl\xC3\xB3 B\xC3\xA1csi"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-04 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Nice interface for Jira, the Ruby way.
+email: lackac@lackac.hu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/rira
+- lib/rira/base.rb
+- lib/rira/model.rb
+- lib/rira.rb
+- test/rira_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/lackac/rira
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Nice interface for Jira, the Ruby way.
+test_files: []
+