jirasync 0.4.3 → 0.4.4

data/README.md

@@ -11,21 +11,19 @@ A suite of utilities to synchronise JIRA projects to the local file system
 
 ### Initial Fetch
 
-The following command will start synchronising a the project `MYPROJ` from the server at
+The following command will start synchronising 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 \
+        --target issues/MYPROJ/raw \
         fetch
 
-
-When this passes successfully the `issues/MYPROJ/json` directory will contain the following structure:
+When this passes successfully the `issues/MYPROJ/raw` directory will contain the following structure:
 
     MYPROJ-1.json
     MYPROJ-2.json
@@ -51,39 +49,43 @@ jira-sync \
     --project MYPROJ  \
     --user jira_user \
     --password jira_password \
-    --target issues/MYPROJ/json \
+    --target issues/MYPROJ/raw \
     update
 
 ~~~
 
+### Fetching and Storing Attachments
+
+ 
+Passing in the `--store-attachments` option leads to attachments being fetched and stored in the local filesystem.
+They will we be stored in the `attachments/` sub-directory of the target directory.
+ 
 ### 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:
 
-~~~ {.bash}
+~~~ {.sh}
 
-    jira-format-issues \
-        --source  issues/MYPROJECT/json \
-        --target  issues/MYPROJECT/markdown
+jira-format-issues \
+    --source  issues/MYPROJ/raw\
+    --target  issues/MYPROJ/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:
 
 ~~~ {.md}
-[MYPROJ-1](https://jira.myorganisation.co/browse/MYPROJ-1): Build a working System
-==================================================================================
+[MYPROJ-1](https://jira.myorganisation.com/browse/MYPROJ-1): Build a working System
+===================================================================================
 
 Type
 :   Story
@@ -123,7 +125,7 @@ These files can be easily searched by ensuring they get indexed by a desktop sea
 [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
+ data* fields which are rendered as definitions at the top of the ticket and *sections* that are rendered as one or more paragraphs
  with a heading. Here is an example file, `custom-data.json`:
 
 ~~~ {.json}
@@ -152,12 +154,15 @@ jira-format-issues \
 
 ## Motivation
 
-Having a local, unix-friendly copy to avoid JIRA performance issues and make information available offline.
+Having a local, unix-friendly copy of all tickets to avoid JIRA performance issues and
+make information available offline.
 
 ## Potential Future Work
 
 - [X] Make progress bar work
 - [X] Make output less noisy
+- [X] Download attachments
+- [ ] Produce tabular output
 - [ ] Deal with authentication problems explicitly
 - [ ] Remove tickets that have been moved to a different project
 - [ ] Use OAuth authentication

data/bin/jira-format-issues

@@ -9,8 +9,10 @@ require 'uri'
 
 class IssueRenderer
     
-    def initialize(custom_data)
+    def initialize(custom_data, source_attachments)
         @custom_data = custom_data
+        @source_attachments = source_attachments
+        @found_attachments = []
     end
 
     def h1(s)
@@ -84,17 +86,36 @@ class IssueRenderer
             }.join("\n" * 2)
     end
 
-    def render_attachments(attachments)
+    def render_attachments(attachments, issue)
         return "" if attachments.length == 0
 
         h2("Attachments") + "\n" * 2 +
             attachments.map{|attachment|
                 filename    = attachment['filename']
-                content_url = attachment['content']
-                "* [#{filename}](#{content_url})"
+                content_url = find_attachment(attachment, issue)
+                extension = File.extname(filename)
+                STDERR.puts("extension: " + extension)
+                image_marker = [".png", ".jpg"].include?(extension) ? "!": ""
+
+                STDERR.puts("marker:     " + image_marker)
+                "* #{image_marker}[#{filename}](#{content_url})"
             }.join("\n" * 2)
     end
 
+    def find_attachment(attachment, issue)
+        filename = "#{issue['key']}-#{attachment['id']}-#{attachment['filename'].gsub(" ", "_")}"
+        if File.file?("#{@source_attachments}/#{filename}")
+            @found_attachments.push(filename)
+            "attachments/#{filename}"
+        else
+            attachment['content']
+        end
+    end
+
+    def found_attachments
+        @found_attachments
+    end
+
     def render(issue)
         
 
@@ -140,7 +161,7 @@ class IssueRenderer
                 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)
+                render_attachments(attachments, issue)
     end
 end
 
@@ -164,6 +185,7 @@ Trollop::die :target, "must be speficied" if !opts[:target]
 source = opts[:source]
 target = opts[:target]
 
+
 FileUtils::mkdir_p target
 
 
@@ -176,7 +198,7 @@ else
     custom_data = {'simple_fields' => [], 'sections' => []}
 end
 
-renderer = IssueRenderer.new(custom_data)
+renderer = IssueRenderer.new(custom_data, "#{source}/attachments")
 
 input_files.each do |file_path|
     begin
@@ -193,3 +215,8 @@ input_files.each do |file_path|
         STDERR.puts(e.to_s)
     end
 end
+
+FileUtils::mkdir_p "#{target}/attachments" unless renderer.found_attachments.empty?
+renderer.found_attachments.each do |filename|
+    FileUtils.cp("#{source}/attachments/#{filename}", "#{target}/attachments/#{filename}")
+end

data/bin/jira-sync

@@ -32,6 +32,7 @@ EOS
     opt :user, "User, defaults to the current system user", :type => :string
     opt :password, "Password, if not specified there, will be an interactive prompt", :type => :string
     opt :target, "Target directory, defaults to the project key", :type => :string
+    opt :store_attachments, "Fetch and store attachments"
 end
 
 Trollop::die :baseurl, "must be speficied" if !opts[:baseurl]
@@ -42,6 +43,7 @@ user = opts[:user] || ENV['USER']
 pw = opts[:password] || prompt_for_password
 target = opts[:target] || opts[:project].chomp
 project = opts[:project]
+store_attachments = opts[:store_attachments]
 
 command = ARGV[0]
 
@@ -52,7 +54,7 @@ end
 
 client = JiraSync::JiraClient.new(opts[:baseurl], user, pw)
 repo = JiraSync::LocalIssueRepository.new(target)
-syncer = JiraSync::Syncer.new(client, repo, project)
+syncer = JiraSync::Syncer.new(client, repo, project, store_attachments)
 
 if command == "fetch"
     if (repo.state_exists?)
@@ -62,6 +64,7 @@ jira-sync \
     --user #{user} \\
     --project #{project} \\
     --target #{target} \\
+    --store-attachments \\
     update
         END
 
@@ -83,6 +86,7 @@ jira-sync \
     --user #{user} \\
     --project #{project} \\
     --target #{target} \\
+    --store-attachments \\
     fetch
         END
 

data/lib/jirasync/jira_client.rb

@@ -3,6 +3,7 @@ module JiraSync
     require 'httparty'
     require 'uri'
     require 'json'
+    require 'parallel'
 
 
     class FetchError < StandardError
@@ -42,6 +43,21 @@ module JiraSync
             end
         end
 
+        def attachments_for_issue(issue)
+            attachments = []
+            Parallel.map(issue['fields']['attachment'], :in_threads => 64) do |attachment|
+                auth = {:username => @username, :password => @password}
+                response = HTTParty.get attachment['content'], {:basic_auth => auth, :timeout => @timeout}
+                if response.code == 200
+                    attachments.push({:data => response.body, :attachment => attachment, :issue => issue})
+                else
+                    raise FetchError.new(response.code, url)
+                end
+            end
+            
+            attachments
+        end
+
         def latest_issue_for_project(project_id)
             url = "#{@baseurl}/rest/api/2/search?"
             auth = {:username => @username, :password => @password}

data/lib/jirasync/local_repository.rb

@@ -40,5 +40,11 @@ module JiraSync
             s = IO.read(file_path)
             JSON.parse(s)
         end
+
+        def save_attachment(issue, attachment, data)
+            FileUtils::mkdir_p("#{@path}/attachments")
+            file_path = "#{@path}/attachments/#{issue['key']}-#{attachment['id']}-#{attachment['filename'].gsub(" ", "_")}"
+            File.write(file_path, data, {:mode => 'wb'})
+        end
     end
-end
+end

data/lib/jirasync/syncer.rb

@@ -5,12 +5,13 @@ module JiraSync
 
     class Syncer
 
-        def initialize(client, repo, project_key)
+        def initialize(client, repo, project_key, store_attachments)
             @client = client
             @project_key = project_key
             latest_issue = @client.latest_issue_for_project(@project_key)['issues'][0]
             @latest_issue_key = latest_issue['key'].split("-")[1].to_i
             @repo = repo
+            @store_attachments = store_attachments
         end
 
         # Fetches a number of tickets in parallel
@@ -26,6 +27,12 @@ module JiraSync
                     issue_project_key = issue['fields']['project']['key']
                     if (issue_project_key == @project_key)
                         @repo.save(issue)
+                        if @store_attachments
+                            attachments = @client.attachments_for_issue(issue)
+                            attachments.each do |attachment|
+                                @repo.save_attachment(attachment[:issue], attachment[:attachment], attachment[:data])
+                            end
+                        end
                     else
                         tickets_moved.push(issue_project_key)
                     end

data/lib/jirasync/version.rb

@@ -1,3 +1,3 @@
 module JiraSync
-    VERSION = "0.4.3"
+    VERSION = "0.4.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirasync
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop