jirasync 0.2 → 0.3

data/README.md

@@ -1,2 +1,143 @@
 # jira-sync
-A utility to synchronise jira projects to the local file system
+
+A suite of utilities to synchronise jira projects to the local file system
+
+## Installation
+
+    gem install jirasync
+
+
+## Usage
+
+### Initial Fetch
+
+The following command will start synchronising a the project `MYPROJ` from the server at
+`https://jira.myorganisation.com`. The issues from that project will be written to the
+`issues/MYPROJ` folder:
+
+
+    jira-sync \
+        --baseurl https://jira.myorganisation.com \
+        --project MYPROJ  \
+        --user jira_user \
+        --password jira_password \
+        --target issues/MYPROJ/json \
+        fetch
+
+
+When this passes successfully the `issues/MYPROJ/json` directory will contain the following structure:
+
+    MYPROJ-1.json
+    MYPROJ-2.json
+    MYPROJ-3.json
+    MYPROJ-4.json
+    …
+    sync_state.json
+
+Each issue file contains a pretty-printed json representation of the ticket. The modified date of the files is set to
+the value of the `updated` field of the corresponding ticket, so that a makefile can be used to render the
+json files incrementally into a more readable representation.
+
+The `sync_state.json` file contains information about the last sync, such as the time and errors that occurred.
+
+### Updating
+
+The following statement will sync issues that have changed or where added during the last sync:
+
+    jira-sync \
+        --baseurl https://jira.myorganisation.com \
+        --project MYPROJ  \
+        --user jira_user \
+        --password jira_password \
+        --target issues/MYPROJ/json \
+        update
+
+
+### Formatting Issues
+
+While json files are very handy to use in code, they are not very readable. The `jira-format-issues` command
+formats json issues to markdown. It is invoked as follows:
+
+    jira-format-issues \
+        --source  issues/MYPROJECT/json \
+        --target  issues/MYPROJECT/markdown
+
+This will create the following structure in the `issues/MYPROJ/markdown`:
+
+    MYPROJ-1.md
+    MYPROJ-2.md
+    MYPROJ-3.md
+    MYPROJ-4.md
+    …
+
+
+The individual files look like this:
+
+    [MYPROJ-1](https://jira.myorganisation.co/browse/MYPROJ-1): Build a working System
+    ==================================================================================
+
+    Type
+    :   Story
+
+    Status
+    :   Closed
+
+    Reporter
+    :   fleipold
+
+    Labels
+    :   triaged
+
+    Updated
+    :   20. Jan 2014 11:30 (UTC)
+
+    Created
+    :   01. Aug 2013 12:29 (UTC)
+
+
+    Description
+    -----------
+
+    The myproj system shall be built to be *delpoyable* and *working*.
+
+
+    Comments
+    --------
+
+    ### fleipold - 20. Jan 2014 12:19 (UTC):
+
+    Is this still relevant?
+
+
+These files can be easily searched by ensuring they get indexed by a desktop search engine, e.g.
+[spotlight](https://gist.github.com/gereon/3150445) on the Mac.
+
+ There is also the possibility to render custom jira fields by supplying a *custom data* file, which declares *simple
+ data* fields which are rendered as definitions at the top of the ticket and *sections* that are rendered as paragraph
+ with a heading. Here is an example file, `custom-data.json`:
+
+     {
+         "simple_fields" : {
+             "Audience" : ["customfield_10123", "value"]
+         },
+         "sections" : {
+             "Release Notes" : ["customfield_10806"]
+         }
+     }
+
+This file can be passed in like this:
+
+    jira-format-issues \
+        --source  issues/MYPROJECT/json \
+        --target  issues/MYPROJECT/markdown \
+        --custom-data-path custom-data.json
+
+## Motivation
+
+Having a local, unix-friendly copy to avoid jira performance issues and make information available offline.
+
+## Potential Future Work
+
+* Remove tickets that have been moved to a different project
+* Use OAuth authentication
+* Improved error handling

data/bin/jira-format-issues

@@ -0,0 +1,195 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'json'
+require 'trollop'
+require 'pathname'
+require 'uri'
+
+
+class IssueRenderer
+    
+    def initialize(custom_data)
+        @custom_data = custom_data
+    end
+
+    def h1(s)
+        s + "\n" + ("=" * s.length)
+    end
+
+    def h2(s)
+        s + "\n" + ("-" * s.length)
+    end
+
+    def wrap(s, width=78)
+        s.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n")
+    end
+
+    def optional_section(title, content)
+        return "" if !content
+        return "" if content == ""
+        h2(title) + "\n\n" + content
+    end
+
+    def format_date(date)
+        date.strftime("%d. %b %Y %H:%M (UTC)")
+    end
+
+    def render_comments(comments)
+        return "" if comments.length == 0
+
+
+        h2("Comments") + "\n" * 2 +
+            (comments.map{|comment|
+                author = comment['author']['name']
+                date = DateTime.parse(comment['updated'])
+                "### #{author} - #{format_date(date)}:\n\n" +
+                    comment['body'] + "\n"
+            }.join("\n-------------------------------------------\n\n"))
+    end
+
+    def render_links(links, project_key)
+        return "" if links.length == 0
+
+        h2("Links") + "\n" * 2 +
+            links.map{|link|
+                outward_issue = link['outwardIssue']
+                inward_issue  = link['inwardIssue']
+                rel_name = link['type']['name']
+                inward_name = link['type']['inward']
+                outward_name = link['type']['outward']
+                if (outward_issue)
+                    uri = URI(outward_issue['self'])
+                    key = outward_issue['key']
+                    uri.path = "/browse/#{key}"
+
+                    if (key.start_with?(project_key))
+                        link = key + ".md"
+                    else
+                        link = uri.to_s
+                    end
+                    "* " + outward_name.capitalize + " [#{key}](#{link})\n"
+                else
+                    uri = URI(inward_issue['self'])
+                    key = inward_issue['key']
+                    uri.path = "/browse/#{key}"
+                    if (key.start_with?(project_key))
+                        link = key + ".md"
+                    else
+                        link = uri.to_s
+                    end
+
+                    "* " + inward_name.capitalize + " [#{key}](#{link.to_s})\n"
+                end
+            }.join("\n" * 2)
+    end
+
+    def render_attachments(attachments)
+        return "" if attachments.length == 0
+
+        h2("Attachments") + "\n" * 2 +
+            attachments.map{|attachment|
+                filename    = attachment['filename']
+                content_url = attachment['content']
+                "* [#{filename}](#{content_url})"
+            }.join("\n" * 2)
+    end
+
+    def render(issue)
+        
+
+        fields =  issue['fields']
+        type = fields['issuetype']['name']
+        key = issue['key']
+        summary = fields['summary']
+        status = fields['status']['name']
+        reporter = fields['reporter']['name']
+        description = fields['description']
+        labels = fields['labels']
+        comments = fields['comment']['comments']
+        links = fields['issuelinks']
+        attachments = fields['attachment']
+        project_key = fields['project']['key']
+
+        created = DateTime.parse(fields['created'])
+        updated = DateTime.parse(fields['updated'])
+
+        uri = URI(issue['self'])
+        uri.path = "/browse/#{key}"
+
+        simple_fields = {
+            "Type" => type,
+            "Status" => status,
+            "Reporter" => reporter,
+            "Labels" => labels.join(", "),
+            "Updated" => format_date(updated),
+            "Created" => format_date(created)
+        }
+        
+        simple_fields = simple_fields.to_a + @custom_data['simple_fields'].map{|kv| [kv[0], kv[1].inject(fields) { |acc, key | acc && acc[key] }]}
+
+        sections = {
+            "Description" => description,
+        }
+
+        sections = sections.to_a + @custom_data['sections'].map{|kv| [kv[0], kv[1].inject(fields) { |acc, key | acc && acc[key] }]}
+
+        return h1("[#{key}](#{uri}): #{summary}") +
+                "\n\n" +
+                simple_fields.map{|kv| kv[0] + "\n:   " + (kv[1] || "-")}.join("\n\n") + "\n\n" +
+                sections.select{|kv| kv[1]}.map{|kv| optional_section(kv[0], kv[1])}.join("\n\n") + "\n\n" +
+                render_links(links, project_key) + "\n\n" +
+                render_comments(comments) + "\n\n" +
+                render_attachments(attachments)
+    end
+end
+
+opts = Trollop::options do
+    banner <<-EOS
+Utility to render jira issues from a source :directory to a target directory
+
+Usage:
+       jira-format-issues [options]
+
+where [options] are:
+EOS
+    opt :source, "Source directory containing json files for issues", :type => :string
+    opt :target, "Target directory", :type => :string
+    opt :custom_data_path, "Custom data description file (optional)", :type => :string
+end
+
+Trollop::die :source, "must be speficied" if !opts[:source]
+Trollop::die :target, "must be speficied" if !opts[:target]
+
+source = opts[:source]
+target = opts[:target]
+
+FileUtils::mkdir_p target
+
+
+input_files = Dir[source + "/*.json"]
+
+custom_data_path = opts[:custom_data_path]
+if (custom_data_path)
+    custom_data = JSON.parse(IO.read(custom_data_path))
+else
+    custom_data = {'simple_fields' => [], 'sections' => []}
+end
+
+renderer = IssueRenderer.new(custom_data)
+
+input_files.each do |file_path|
+    begin
+        basename = Pathname.new(file_path).basename(".json").to_s
+        if (basename == "sync_state")
+            next
+        end
+        output_file = target + "/" + basename + ".md"
+        issue = JSON.parse(IO.read(file_path))
+        markdown =  renderer.render(issue)
+        File.write(output_file, markdown)
+    rescue => e
+        STDERR.puts("Problem rendering '#{file_path}'")
+        STDERR.puts(e.to_s)
+    end
+end

data/bin/jira-sync

@@ -4,10 +4,8 @@ require 'rubygems'
 require 'io/console'
 require 'trollop'
 
-
 require 'jirasync'
 
-
 def prompt_for_password
     print("Please enter password: ")
     pw = STDIN.noecho(&:gets).chomp
@@ -43,6 +41,7 @@ Trollop::die :project, "must be speficied" if !opts[:project]
 user = opts[:user] || ENV['USER']
 pw = opts[:password] || prompt_for_password
 target = opts[:target] || opts[:project].chomp
+project = opts[:project]
 
 command = ARGV[0]
 
@@ -53,12 +52,47 @@ end
 
 client = JiraSync::JiraClient.new(opts[:baseurl], user, pw)
 repo = JiraSync::LocalIssueRepository.new(target)
-syncer = JiraSync::Syncer.new(client, repo, opts[:project].chomp)
+syncer = JiraSync::Syncer.new(client, repo, project)
 
 if command == "fetch"
+    if (repo.state_exists?)
+        update_statement=<<-END
+jira-sync \
+    --baseurl #{opts[:baseurl]} \\
+    --user #{user} \\
+    --project #{project} \\
+    --target #{target} \\
+    update
+        END
+
+        STDERR.puts <<-END
+Synchronisation state file found. Please use 'update' for incremental update
+or sync to an empty directory. Try to use a statement along the following lines
+#{update_statement}
+        END
+        exit 1
+    end
     syncer.fetch_all
 end
 
 if command == "update"
+    if (!repo.state_exists?)
+        fetch_statement=<<-END
+jira-sync \
+    --baseurl #{opts[:baseurl]} \\
+    --user #{user} \\
+    --project #{project} \\
+    --target #{target} \\
+    fetch
+        END
+
+        STDERR.puts <<-END
+No synchronisation state file found. Please use 'fetch' for an initial download.
+Try to use a statement along the following lines
+#{fetch_statement}
+        END
+        exit 1
+    end
+
     syncer.update
-end
+end

data/jirasync.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
                     an incremental update.
 
                     Each ticket is stored in a simple, pretty printed JSON file.'
-  s.version      = '0.2'
+  s.version      = '0.3'
   s.platform     = Gem::Platform::RUBY
 
   s.files        = ['bin/jira-sync']

data/lib/jirasync/jira_client.rb

@@ -4,6 +4,15 @@ module JiraSync
     require 'uri'
     require 'json'
 
+    class FetchError < StandardError
+        attr_reader :status, :message
+
+        def initialize(status, message)
+            @reason = status
+            @message = message
+        end
+    end
+
 
     class JiraClient
 
@@ -20,7 +29,7 @@ module JiraSync
             if response.code == 200
                 response.parsed_response
             else
-                raise "no issue found for #{jira_id}. response code was #{response.code}, url was #{url}"
+                raise FetchError(response.code, "error retrieving #{jira_id}. response code was #{response.code}, url was #{url}")
             end
         end
 
@@ -32,7 +41,7 @@ module JiraSync
             if response.code == 200
                 response.parsed_response
             else
-                raise "no issue found for #{project_id}. response code was #{response.code}, url was #{url}"
+                raise FetchError(response.status, "no issue found for #{project_id}. response code was #{response.code}, url was #{url}")
             end
         end
 
@@ -45,7 +54,7 @@ module JiraSync
             if response.code == 200
                 response.parsed_response
             else
-                raise "no issue found for #{project_id}. response code was #{response.code}, url was #{url}"
+                raise FetchError(response.status, "no issue found for #{project_id}. response code was #{response.code}, url was #{url}")
             end
         end
 

data/lib/jirasync/local_repository.rb

@@ -20,6 +20,11 @@ module JiraSync
             File.utime(DateTime.now.to_time, updateTime.to_time, file_path)
         end
 
+        def state_exists?
+            file_path = "#{@path}/sync_state.json"
+            File.exist?(file_path)
+        end
+
         def save_state(state)
             json = JSON.pretty_generate(state)
             file_path = "#{@path}/sync_state.json"

data/lib/jirasync/syncer.rb

@@ -3,7 +3,6 @@ module JiraSync
     require 'json'
     require 'date'
 
-
     class Syncer
 
         def initialize(client, repo, project_key)
@@ -14,7 +13,6 @@ module JiraSync
             @repo = repo
         end
 
-
         # Fetches a number of tickets in parallel
         # prints progress information to stderr
         # and returns a list of tickets that
@@ -31,6 +29,12 @@ module JiraSync
                     else
                         STDERR.puts("Skipping ticket #{key} which has moved to #{issue_project_key}.")
                     end
+
+                rescue FetchError => e
+                    if (e.status != 404)
+                        STDERR.puts(e.to_s)
+                        keys_with_errors.push(key)
+                    end
                 rescue => e
                     STDERR.puts(e.to_s)
                     keys_with_errors.push(key)
@@ -55,9 +59,9 @@ module JiraSync
             STDERR.puts("Fetching issues that have changes since #{since.to_s}")
             issues = @client.changed_since(@project_key, since)['issues'].map { |issue| issue['key'] }
             STDERR.puts("Updated Issues")
-            STDERR.puts(issues.join(", "))
+            STDERR.puts(issues.empty? ?  "None" : issues.join(", "))
             STDERR.puts("Issues with earlier errors")
-            STDERR.puts(state['errors'].join(", "))
+            STDERR.puts(state['errors'].empty? ? "None" : state['errors'].join(", "))
             keys_with_errors = fetch(issues + state['errors'])
             @repo.save_state({"time" => start_time, "errors" => keys_with_errors})
         end

data/lib/jirasync/version.rb

@@ -1,3 +1,3 @@
 module JiraSync
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirasync
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -65,6 +65,7 @@ description: ! "jirasync synchronises tickets from a jira project to the local\n
   printed JSON file."
 email: ''
 executables:
+- jira-format-issues
 - jira-sync
 extensions: []
 extra_rdoc_files: []
@@ -74,6 +75,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/jira-format-issues
 - bin/jira-sync
 - jira-sync.gemspec
 - jirasync.gemspec