sappho-data-publisher 0.2.2 → 0.2.3

data/lib/sappho-data-publisher/atlassian_app.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'sappho-basics/module_register'

data/lib/sappho-data-publisher/configuration.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'sappho-basics/module_register'

data/lib/sappho-data-publisher/confluence.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'sappho-data-publisher/atlassian_app'

data/lib/sappho-data-publisher/custom_liquid.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'liquid'

data/lib/sappho-data-publisher/jira.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'sappho-data-publisher/atlassian_app'
@@ -23,20 +23,23 @@ module Sappho
         def gatherData pageData, parameters
           checkLoggedIn
           # process a single issue fetch request
-          if id = parameters['id']
-            @logger.info "fetching Jira issue #{id}"
-            getJiraIssueDetails @appServer.getIssue(@token, id), pageData
+          if key = parameters['key']
+            @logger.info "fetching Jira issue #{key}"
+            issue = @appServer.getIssue(@token, key)
+            pageData['pagename'] = issue['summary'] unless pageData['pagename']
+            processIssues pageData, [issue]
           end
           # process a multi-issue, via filter, fetch request
           if filterId = parameters['filterId']
             @logger.info "fetching all Jira issues included in filter #{filterId}"
             issues = @appServer.getIssuesFromFilter @token, filterId
-            pageData['issues'] = cookedIssues = []
-            issues.each { |issue|
-              cookedIssue = { 'key' => issue['key'] }
-              getJiraIssueDetails issue, cookedIssue
-              cookedIssues << cookedIssue
-            }
+            processIssues pageData, issues
+          end
+          # process a multi-issue, via JQL, fetch request
+          if jql = parameters['jql']
+            maxResults = parameters['max']
+            issues = jqlQuery jql, maxResults
+            processIssues pageData, issues
           end
           # process a group membership fetch request
           if groupName = parameters['groupName']
@@ -48,26 +51,10 @@ module Sappho
                   'username' => user['name'],
                   'fullName' => user['fullname'],
                   'email' => user['email']
-            }}
+              } }
           end
         end
 
-        def getJiraIssueDetails issue, pageData
-          ['summary', 'description', 'assignee', 'components', 'created', 'duedate', 'priority',
-           'project', 'reporter', 'resolution', 'status', 'type', 'updated'].each { |key|
-            pageData[key] = issue[key]
-          }
-          pageData['pagename'] = issue['summary'] unless pageData['pagename']
-          pageData['cf'] = customFields = {}
-          @allCustomFields.each { |customField|
-            customFields[cfname customField['id']] = { 'name' => customField['name'] }
-          }
-          issue['customFieldValues'].each { |customFieldValue|
-            customFields[cfname customFieldValue['customfieldId']]['values'] =
-                customFieldValue['values']
-          }
-        end
-
         def getUserFullName username
           checkLoggedIn
           user = @users[username]
@@ -80,6 +67,44 @@ module Sappho
 
         private
 
+        def processIssues pageData, issues
+          pageData['issues'] = cookedIssues = []
+          cookIssues issues, cookedIssues
+        end
+
+        def jqlQuery jql, maxresults
+          @logger.info "fetching up to #{maxresults} Jira issues for #{jql}"
+          return @appServer.getIssuesFromJqlSearch @token, jql, maxresults
+        end
+
+        def getJiraIssueDetails issue, cookedIssue
+          ['id', 'key', 'summary', 'description', 'assignee', 'created', 'duedate', 'priority',
+           'project', 'reporter', 'resolution', 'status', 'type', 'updated'].each { |key|
+            cookedIssue[key] = issue[key]
+          }
+          cookedIssue['components'] = components = []
+          issue['components'].each { |component| components << component['name'] }
+          cookedIssue['cf'] = customFields = {}
+          @allCustomFields.each { |customField|
+            customFields[cfname customField['id']] = {'name' => customField['name']}
+          }
+          issue['customFieldValues'].each { |customFieldValue|
+            customFields[cfname customFieldValue['customfieldId']]['values'] =
+                customFieldValue['values']
+          }
+          cookedIssue['subtasks'] = cookedSubtasks = []
+          subtasks = jqlQuery "parent=#{issue['key']}", 100
+          cookIssues subtasks, cookedSubtasks
+        end
+
+        def cookIssues issues, cookedIssues
+          issues.each { |issue|
+            cookedIssue = {}
+            getJiraIssueDetails issue, cookedIssue
+            cookedIssues << cookedIssue
+          }
+        end
+
         def cfname name
           name.sub /customfield_/, ''
         end

data/lib/sappho-data-publisher/publisher.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'liquid'

data/lib/sappho-data-publisher/version.rb

@@ -1,16 +1,16 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 module Sappho
   module Data
     module Publisher
       NAME = 'sappho-data-publisher'
-      VERSION = '0.2.2'
+      VERSION = '0.2.3'
       AUTHORS = ['Andrew Heald']
       EMAILS = ['andrew@heald.co.uk']
-      HOMEPAGE = 'https://github.com/sappho/sappho-data-publisher/wiki'
+      HOMEPAGE = 'https://wiki.sappho.org.uk/display/DP/sappho-data-publisher'
       SUMMARY = 'Publishes aggregated data to formatted pages on a wiki'
       DESCRIPTION = 'See the project home page for more information'
     end

data/lib/sappho-data-publisher.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'sappho-basics/module_register'

data/test/data/jira-results.yml

@@ -2,43 +2,51 @@
 # See http://yaml.org/spec for syntax help
 
 TEST-42-A:
-  summary: Testing 123
   pagename: Testing 123
-  description: This is a test.
-  assignee:
-  components:
-  created:
-  duedate:
-  priority:
-  project:
-  reporter:
-  resolution:
-  status:
-  type:
-  updated:
-  cf:
-    !str 10500: { name: Service }
-    !str 10501: { name: Type, values: [ Business Process ] }
-    !str 10502: { name: Invoice Number }
-    !str 10503: { name: Customer, values: [ Bank of England ] }
+  issues:
+    - id: 1234
+      key: TEST-42
+      summary: Testing 123
+      description: This is a test.
+      assignee:
+      components: []
+      created:
+      duedate:
+      priority:
+      project:
+      reporter:
+      resolution:
+      status:
+      type:
+      updated:
+      cf:
+        !str 10500: { name: Service }
+        !str 10501: { name: Type, values: [ Business Process ] }
+        !str 10502: { name: Invoice Number }
+        !str 10503: { name: Customer, values: [ Bank of England ] }
+      subtasks: []
 
 TEST-42-B:
-  summary: Testing 123
   pagename: Test Page
-  description: This is a test.
-  assignee:
-  components:
-  created:
-  duedate:
-  priority:
-  project:
-  reporter:
-  resolution:
-  status:
-  type:
-  updated:
-  cf:
-    !str 10500: { name: Service }
-    !str 10501: { name: Type, values: [ Business Process ] }
-    !str 10502: { name: Invoice Number }
-    !str 10503: { name: Customer, values: [ Bank of England ] }
+  issues:
+    - id: 1234
+      key: TEST-42
+      summary: Testing 123
+      description: This is a test.
+      assignee:
+      components: []
+      created:
+      duedate:
+      priority:
+      project:
+      reporter:
+      resolution:
+      status:
+      type:
+      updated:
+      cf:
+        !str 10500: { name: Service }
+        !str 10501: { name: Type, values: [ Business Process ] }
+        !str 10502: { name: Invoice Number }
+        !str 10503: { name: Customer, values: [ Bank of England ] }
+      subtasks: []

data/test/data/jira.yml

@@ -9,10 +9,12 @@ users:
 issues:
 
   TEST-42:
+    id: 1234
+    key: TEST-42
     summary: Testing 123
     description: This is a test.
     assignee:
-    components:
+    components: []
     created:
     duedate:
     priority:

data/test/ruby/confluence_test.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'helper'

data/test/ruby/custom_liquid_test.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'helper'

data/test/ruby/helper.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'rubygems'

data/test/ruby/jira_test.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'helper'
@@ -55,24 +55,24 @@ class JiraTest < Test::Unit::TestCase
 
   def test_data_gathering_pagename_as_summary
     # pagename will be a copy of the issue summary
-    assert_data_gathered({}, { 'id' => 'TEST-42' }, 'TEST-42-A')
+    assert_data_gathered({}, {'key' => 'TEST-42'}, 'TEST-42-A')
   end
 
   def test_data_gathering_pagename_as_supplied
     # pagename supplied already so should not be set by data gatherer
-    assert_data_gathered({ 'pagename' => 'Test Page' }, { 'id' => 'TEST-42' }, 'TEST-42-B')
+    assert_data_gathered({'pagename' => 'Test Page'}, {'key' => 'TEST-42'}, 'TEST-42-B')
   end
 
   def test_data_gathering_from_invalid_issue
     assert_raise RuntimeError do
-      assert_data_gathered({}, { 'id' => 'TEST-999' }, nil)
+      assert_data_gathered({}, {'key' => 'TEST-999'}, nil)
     end
   end
 
   def test_data_gathering_without_connecting
     assert_raise RuntimeError do
       # this would be okay if connected, but we're not
-      assert_data_gathered({}, { 'id' => 'TEST-42' }, 'TEST-42-A', true)
+      assert_data_gathered({}, {'key' => 'TEST-42'}, 'TEST-42-A', true)
     end
     # keep the teardown happy by connecting anyway
     connect

data/test/ruby/mock_atlassian_app.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 class MockAtlassianApp

data/test/ruby/mock_confluence.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'mock_atlassian_app'

data/test/ruby/mock_jira.rb

@@ -1,6 +1,6 @@
-# See https://github.com/sappho/sappho-data-publisher/wiki for project documentation.
-# This software is licensed under the GNU Affero General Public License, version 3.
-# See http://www.gnu.org/licenses/agpl.html for full details of the license terms.
+# See https://wiki.sappho.org.uk/display/DP/sappho-data-publisher for project documentation.
+# This software is licensed under the GNU General Public License, version 3.
+# See http://www.gnu.org/licenses/gpl.html for full details of the license terms.
 # Copyright 2012 Andrew Heald.
 
 require 'mock_atlassian_app'
@@ -23,10 +23,10 @@ class MockJira < MockAtlassianApp
     @allCustomFields
   end
 
-  def getIssue token, id
+  def getIssue token, key
     assert_token_valid token
-    raise 'issue does not exist' unless @issues.has_key? id
-    @issues[id]
+    raise 'issue does not exist' unless @issues.has_key? key
+    @issues[key]
   end
 
   def getUser token, username
@@ -36,4 +36,9 @@ class MockJira < MockAtlassianApp
     @users[username]
   end
 
+  def getIssuesFromJqlSearch token, jql, maxResults
+    assert_token_valid token
+    return []
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sappho-data-publisher
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Andrew Heald
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-10 00:00:00 Z
+date: 2012-10-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -104,7 +104,7 @@ files:
 - test/ruby/mock_atlassian_app.rb
 - test/ruby/mock_confluence.rb
 - test/ruby/mock_jira.rb
-homepage: https://github.com/sappho/sappho-data-publisher/wiki
+homepage: https://wiki.sappho.org.uk/display/DP/sappho-data-publisher
 licenses: []
 
 post_install_message: