sappho-data-publisher 0.1.0

data/bin/sappho-data-publisher

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'sappho-data-publisher'
+
+Sappho::Data::Publisher::CommandLine.new.run

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

@@ -0,0 +1,27 @@
+# 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.
+# Copyright 2012 Andrew Heald.
+
+require 'sappho-data-publisher/modules'
+require 'yaml'
+
+module Sappho
+  module Data
+    module Publisher
+
+      class Configuration
+
+        attr_reader :data
+
+        def initialize
+          filename = File.expand_path(ARGV[0] || 'config.yml')
+          @data = YAML.load_file filename
+          Modules.instance.get(:logger).warn "configuration loaded from #{filename}"
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# 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.
+# Copyright 2012 Andrew Heald.
+
+require 'sappho-data-publisher/modules'
+require 'xmlrpc/client'
+
+module Sappho
+  module Data
+    module Publisher
+
+      class Confluence
+
+        def initialize
+          @config = Modules.instance.get :configuration
+          @logger = Modules.instance.get :logger
+          url = @config.data['confluence.url']
+          @wiki = XMLRPC::Client.new2("#{url}/rpc/xmlrpc").proxy('confluence1')
+          @token = @wiki.login @config.data['confluence.username'], @config.data['confluence.password']
+          @logger.info "Confluence #{url} is online"
+        end
+
+        def getGlobalConfiguration
+          pageName = @config.data['confluence.global.config.page.name']
+          return getPage @config.data['confluence.config.space.key'], pageName if pageName
+          ''
+        end
+
+        def getConfiguration
+          getPage @config.data['confluence.config.space.key'], @config.data['confluence.config.page.name']
+        end
+
+        def getTemplate pageData, parameters
+          getPage parameters['templatespace'], parameters['templatepage']
+        end
+
+        def getScript rawPage
+          rawPage.scan(/\{noformat.*?\}(.*?)\{noformat\}/m).each { |pageData| yield pageData[0] }
+        end
+
+        def publish content, pageData, parameters
+          setPage parameters['space'], parameters['parent'], pageData['pagename'], content
+        end
+
+        def shutdown
+          @wiki.logout @token
+          @logger.info 'disconnected from Confluence'
+        end
+
+        private
+
+        def getPage spaceKey, pageName
+          @logger.info "reading wiki page #{spaceKey}:#{pageName}"
+          @wiki.getPage(@token, spaceKey, pageName)['content']
+        end
+
+        def setPage spaceKey, parentPageName, pageName, content
+          begin
+            page = @wiki.getPage(@token, spaceKey, pageName)
+            page['content'] = content
+            @logger.info "rewriting existing wiki page #{spaceKey}:#{pageName}"
+          rescue
+            page = {
+              'space' => spaceKey,
+              'parentId' => @wiki.getPage(@token, spaceKey, parentPageName)['id'],
+              'title' => pageName,
+              'content' => content }
+            @logger.info "creating new wiki page #{spaceKey}:#{pageName} as child of #{parentPageName}"
+          end
+          @wiki.storePage @token, page
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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.
+# Copyright 2012 Andrew Heald.
+
+require 'rubygems'
+gem 'liquid'
+require 'liquid'
+require 'sappho-data-publisher/modules'
+
+module Sappho
+  module Data
+    module Publisher
+
+      class CustomLiquid
+
+        def CustomLiquid.setup
+          Liquid::Template.register_filter(Fullname)
+          Liquid::Template.register_tag('squash', Squash)
+        end
+
+        module Fullname
+
+          def fullname username
+            begin
+              Modules.instance.get('AddressBook').getUserFullName(username)
+            rescue
+              '** John Doe **'
+            end
+          end
+
+        end
+
+        class Squash < Liquid::Block
+
+          def initialize tag_name, markup, tokens
+            super
+            @message = (markup ? markup.to_s : '')
+            @message = @message.length > 0 ? @message : 'This information has not been supplied.'
+          end
+
+          def render context
+            wiki = []
+            super.each { |line| wiki << line unless line.strip == ''}
+            wiki.size > 0 ? wiki.join : @message
+          end
+
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# 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.
+# Copyright 2012 Andrew Heald.
+
+require 'sappho-data-publisher/modules'
+require 'soap/wsdlDriver'
+
+module Sappho
+  module Data
+    module Publisher
+
+      class Jira
+
+        def initialize
+          config = Modules.instance.get :configuration
+          @logger = Modules.instance.get :logger
+          url = config.data['jira.url']
+          @jira = SOAP::WSDLDriverFactory.new("#{url}/rpc/soap/jirasoapservice-v2?wsdl").create_rpc_driver
+          @token = @jira.login config.data['jira.username'], config.data['jira.password']
+          @allCustomFields = @jira.getCustomFields @token
+          @logger.info "Jira #{url} is online"
+          @users = {}
+        end
+
+        def gatherData pageData, parameters
+          id = parameters['id']
+          @logger.info "reading Jira issue #{id}"
+          issue = @jira.getIssue @token, id
+          pageData['summary'] = summary = issue['summary']
+          pageData['pagename'] = summary unless pageData['pagename']
+          pageData['description'] = issue['description']
+          pageData['customFields'] = customFields = {}
+          @allCustomFields.each { |customField|
+            customFields[customField['id']] = {
+                'name' => customField['name'],
+                'values' => nil
+            }
+          }
+          issue['customFieldValues'].each { |customFieldValue|
+            customFields[customFieldValue['customfieldId']]['values'] = customFieldValue['values']
+          }
+        end
+
+        def getUserFullName username
+          user = @users[username]
+          unless user
+            @logger.info "reading Jira user details for #{username}"
+            @users[username] = user = @jira.getUser(@token, username)
+          end
+          user['fullname']
+        end
+
+        def shutdown
+          @jira.logout @token
+          @logger.info 'disconnected from Jira'
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# 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.
+# Copyright 2012 Andrew Heald.
+
+require 'singleton'
+
+module Sappho
+  module Data
+    module Publisher
+
+      class Modules
+
+        include Singleton
+
+        def initialize
+          @modules = {}
+        end
+
+        def set name, mod
+          @modules[name] = mod
+        end
+
+        def get name
+          @modules[name]
+        end
+
+        def shutdown
+          each { |mod| mod.shutdown }
+        end
+
+        def each
+          @modules.each do |name, mod|
+            begin
+              yield mod
+            rescue
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# 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.
+# Copyright 2012 Andrew Heald.
+
+require 'rubygems'
+gem 'liquid'
+require 'liquid'
+require 'yaml'
+require 'sappho-data-publisher/modules'
+
+module Sappho
+  module Data
+    module Publisher
+
+      class Publisher
+
+        def publish
+          modules = Modules.instance
+          logger = modules.get :logger
+          configurator = modules.get modules.get(:configuration).data['config.module']
+          globalScript = ''
+          configurator.getScript(configurator.getGlobalConfiguration) { |configChunk| globalScript += configChunk }
+          configurator.getScript configurator.getConfiguration do |configChunk|
+            allData = YAML.load(globalScript + configChunk)
+            pageData = allData['page']
+            if pageData
+              logger.info "---- publishing #{pageData['id']} ----"
+              pageData['sources'].each do |source|
+                id = source['source']
+                logger.info "collecting #{id} source data"
+                modules.get(id).gatherData pageData, source['parameters']
+              end
+              pageData['publications'].each do |publication|
+                id = publication['destination']
+                logger.info "publishing data to #{id}"
+                dest = modules.get(id)
+                params = publication['parameters']
+                template = ''
+                dest.getScript(dest.getTemplate pageData, params) { |templateChunk| template += templateChunk }
+                dest.publish Liquid::Template.parse(template).render('data' => pageData), pageData, params
+              end
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# 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.
+# Copyright 2012 Andrew Heald.
+
+module Sappho
+  module Data
+    module Publisher
+      VERSION = "0.1.0"
+      HOMEPAGE = "https://github.com/sappho/sappho-data-publisher/wiki"
+    end
+  end
+end

data/lib/sappho-data-publisher.rb

@@ -0,0 +1,41 @@
+# 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.
+# Copyright 2012 Andrew Heald.
+
+require 'logger'
+require 'sappho-data-publisher/modules'
+require 'sappho-data-publisher/publisher'
+require 'sappho-data-publisher/configuration'
+require 'sappho-data-publisher/confluence'
+require 'sappho-data-publisher/jira'
+require 'sappho-data-publisher/custom_liquid'
+require 'sappho-data-publisher/version'
+
+module Sappho
+  module Data
+    module Publisher
+
+      class CommandLine
+
+        def run
+          logger = Logger.new STDOUT
+          logger.level = Logger::INFO
+          logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
+          logger.info "sappho-data-publisher version #{VERSION} - #{HOMEPAGE}"
+          modules = Modules.instance
+          modules.set :logger, logger
+          modules.set :configuration, Configuration.new
+          modules.set 'Jira', (jira = Jira.new)
+          modules.set 'AddressBook', jira
+          modules.set 'Confluence', Confluence.new
+          CustomLiquid.setup
+          Publisher.new.publish
+          modules.shutdown
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: sappho-data-publisher
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andrew Heald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: liquid
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id002
+description: See the project home page for more information
+email: 
+- andrew@heald.co.uk
+executables: 
+- sappho-data-publisher
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/sappho-data-publisher
+- lib/sappho-data-publisher.rb
+- lib/sappho-data-publisher/configuration.rb
+- lib/sappho-data-publisher/confluence.rb
+- lib/sappho-data-publisher/custom_liquid.rb
+- lib/sappho-data-publisher/jira.rb
+- lib/sappho-data-publisher/modules.rb
+- lib/sappho-data-publisher/publisher.rb
+- lib/sappho-data-publisher/version.rb
+homepage: https://github.com/sappho/sappho-data-publisher/wiki
+licenses: []
+
+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: sappho-data-publisher
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Publishes aggregated data to formatted pages on a wiki
+test_files: []
+