jirasync 0.4.2 → 0.4.3

data/.gitignore

@@ -1,4 +1,3 @@
-*.gem
 *.rbc
 .bundle
 .config

data/README.md

@@ -1,6 +1,6 @@
 # jira-sync
 
-A suite of utilities to synchronise jira projects to the local file system
+A suite of utilities to synchronise JIRA projects to the local file system
 
 ## Installation
 
@@ -44,26 +44,34 @@ The `sync_state.json` file contains information about the last sync, such as the
 
 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
+~~~ {.bash}
+
+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:
+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}
 
     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
@@ -73,41 +81,43 @@ This will create the following structure in the `issues/MYPROJ/markdown`:
 
 The individual files look like this:
 
-    [MYPROJ-1](https://jira.myorganisation.co/browse/MYPROJ-1): Build a working System
-    ==================================================================================
+~~~ {.md}
+[MYPROJ-1](https://jira.myorganisation.co/browse/MYPROJ-1): Build a working System
+==================================================================================
 
-    Type
-    :   Story
+Type
+:   Story
 
-    Status
-    :   Closed
+Status
+:   Closed
 
-    Reporter
-    :   fleipold
+Reporter
+:   fleipold
 
-    Labels
-    :   triaged
+Labels
+:   triaged
 
-    Updated
-    :   20. Jan 2014 11:30 (UTC)
+Updated
+:   20. Jan 2014 11:30 (UTC)
 
-    Created
-    :   01. Aug 2013 12:29 (UTC)
+Created
+:   01. Aug 2013 12:29 (UTC)
 
 
-    Description
-    -----------
+Description
+-----------
 
-    The myproj system shall be built to be *delpoyable* and *working*.
+The myproj system shall be built to be *delpoyable* and *working*.
 
 
-    Comments
-    --------
+Comments
+--------
 
-    ### fleipold - 20. Jan 2014 12:19 (UTC):
+### fleipold - 20. Jan 2014 12:19 (UTC):
 
-    Is this still relevant?
+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.
@@ -116,28 +126,39 @@ These files can be easily searched by ensuring they get indexed by a desktop sea
  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"]
-         }
-     }
+~~~ {.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
+~~~ {.bash}
+
+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.
+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
+- [X] Make progress bar work
+- [X] Make output less noisy
+- [ ] Deal with authentication problems explicitly
+- [ ] Remove tickets that have been moved to a different project
+- [ ] Use OAuth authentication
+

data/jirasync.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_dependency('trollop')
   s.add_dependency('httparty')
   s.add_dependency('parallel')
+  s.add_dependency('ruby-progressbar')
 end

data/lib/jirasync/jira_client.rb

@@ -4,6 +4,7 @@ module JiraSync
     require 'uri'
     require 'json'
 
+
     class FetchError < StandardError
         attr_reader :status, :url
 
@@ -24,12 +25,16 @@ module JiraSync
             @username = username
             @password = password
             @baseurl = baseurl
+            @timeout = 15
+            @first_requets_timeout = 60
         end
 
+
+
         def get(jira_id)
             url = "#{@baseurl}/rest/api/latest/issue/#{jira_id}"
             auth = {:username => @username, :password => @password}
-            response = HTTParty.get url, {:basic_auth => auth}
+            response = HTTParty.get url, {:basic_auth => auth, :timeout => @timeout}
             if response.code == 200
                 response.parsed_response
             else
@@ -41,11 +46,15 @@ module JiraSync
             url = "#{@baseurl}/rest/api/2/search?"
             auth = {:username => @username, :password => @password}
 
-            response = HTTParty.get url, {:basic_auth => auth, :query => {:jql => 'project="' + project_id + '" order by created', fields: 'summary,updated', maxResults: '1'}}
+            response = HTTParty.get url, {
+                :basic_auth => auth,
+                :query => {:jql => 'project="' + project_id + '" order by created', fields: 'summary,updated', maxResults: '1'},
+                :timeout => @first_requets_timeout
+            }
             if response.code == 200
                 response.parsed_response
             else
-                raise FetchError.new(response.status, url)
+                raise FetchError.new(response.code, url)
             end
         end
 
@@ -54,22 +63,30 @@ module JiraSync
             auth = {:username => @username, :password => @password}
             jql = 'project = "' + project_id + '" AND updated > ' + (date.to_time.to_i * 1000).to_s
             # "' + date.to_s + '"'
-            response = HTTParty.get url, {:basic_auth => auth, :query => {:jql => jql, fields: 'summary,updated', maxResults: '1000'}}
+            response = HTTParty.get url, {
+                :basic_auth => auth,
+                :query => {:jql => jql, fields: 'summary,updated', maxResults: '1000'},
+                :timeout => @timeout
+            }
             if response.code == 200
                 response.parsed_response
             else
-                raise FetchError.new(response.status, url)
+                raise FetchError.new(response.code, url)
             end
         end
 
         def project_info(project_id)
             url = "#{@baseurl}/rest/api/2/project/#{project_id}"
             auth = {:username => @username, :password => @password}
-            response = HTTParty.get url, {:basic_auth => auth, :query => {:jql => 'project="' + project_id + '"', fields: 'summary,updated', maxResults: '50'}}
+            response = HTTParty.get url, {
+                :basic_auth => auth,
+                :query => {:jql => 'project="' + project_id + '"', fields: 'summary,updated', maxResults: '50'},
+                :timeout => @timeout
+            }
             if response.code == 200
                 response.parse_response
             else
-                raise FetchError(response.status, url)
+                raise FetchError(response.code, url)
             end
 
         end

data/lib/jirasync/syncer.rb

@@ -19,32 +19,34 @@ module JiraSync
         # couldn't be fetched.
         def fetch(keys)
             keys_with_errors = []
-            Parallel.each_with_index(keys, :in_threads => 64) do |key, index|
-                STDERR.puts(key) if ((index % 100) == 0)
+            tickets_moved = []
+            Parallel.each_with_index(keys, :in_threads => 64, :progress => {title:"Fetching", output: STDERR}) do |key, index|
                 begin
                     issue = @client.get(key)
                     issue_project_key = issue['fields']['project']['key']
                     if (issue_project_key == @project_key)
                         @repo.save(issue)
                     else
-                        STDERR.puts("Skipping ticket #{key} which has moved to #{issue_project_key}.")
+                        tickets_moved.push(issue_project_key)
                     end
 
                 rescue FetchError => e
                     if (e.status != 404)
-                        STDERR.puts(e.to_s)
                         keys_with_errors.push(key)
                     else
-                        STDERR.puts("Ignoring 404 for ticket #{key}")
+                        # Ticket has disappeared
                     end
                 rescue => e
                     STDERR.puts(e.to_s)
                     keys_with_errors.push(key)
                 end
             end
-            keys_with_errors.sort
+            keys_with_errors.sort!
+            STDERR.puts("Errors fetching these tickets: #{keys_with_errors.join(",")}")
+            keys_with_errors
         end
 
+        # Fetches all tickets for the project
         def fetch_all
             start_time = DateTime.now
 
@@ -54,16 +56,16 @@ module JiraSync
             @repo.save_state({"time" => start_time, "errors" => keys_with_errors})
         end
 
+        # Fetches only tickets that have been changed/ added since the previous fetch/ update
         def update()
             state = @repo.load_state()
             start_time = DateTime.now
             since = DateTime.parse(state['time']).new_offset(0)
             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.empty? ?  "None" : issues.join(", "))
-            STDERR.puts("Issues with earlier errors")
-            STDERR.puts(state['errors'].empty? ? "None" : state['errors'].join(", "))
+            STDERR.puts("Updated Issues: #{issues.empty? ?  "None" : issues.join(",")}")
+            STDERR.print("Retrying issues with earlier errors: ")
+            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.4.2"
+    VERSION = "0.4.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirasync
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! "jirasync synchronises tickets from a jira project to the local\n                    file
   system. It supports a complete fetch operation as well as\n                    an
   incremental update.\n\n                    Each ticket is stored in a simple, pretty