gitjira 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6df10c782e1e083a1e4b765f5ba5151e6487ea25
-  data.tar.gz: dba31206fe7605e1c7987c87faccc03bcf52f85f
+  metadata.gz: 81c1bc701b41a93ef30dcee92ac3bdb2444e0126
+  data.tar.gz: 9cf5d0e5f6dadbe1e7670a290c60156f289e8f87
 SHA512:
-  metadata.gz: 2071da8a3b4178f6f2ea18aa201f4ee8913a976314de85fd5671821c92eda4efdbd06913d2f37b5983c0e0840b2f8ac9697a4ca42a4da33325990e987d02635f
-  data.tar.gz: 8094dc7d078a3c692e9744ca1d4340e8f904b02f511128d71cf55e8dadbf82b604351f2b5d3d094f0a4fe6324c7ec314ee111fb73515ecf1eb491da2bc51dab2
+  metadata.gz: b0521a9764b17f453add243ca20c59ee78db0c0586e5332e6350e1702e4ad0b5b3dea52c99496fc63485f14fcb5881b91067b08fa337e648fa53bc43fb0b21f6
+  data.tar.gz: 2f6d00ac16bda851b1d7093122405e33cad4531ed6686d4ace566848132902c2f4ad3113573c9387b120a63e6dbf8c66477d27b35d2f93346297d5390e628d59

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitjira (0.2.0)
+    gitjira (0.3.0)
       highline
       rest-client (~> 1.6)
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 TODO: Write your name
+Copyright (c) 2013 Sigimera Ltd.
 
 MIT License
 

data/README.md

@@ -24,7 +24,7 @@ Install via rubygems.org:
 
 ## Setup:
 
-    $ git-jira init
+    $ git-jira init # or gj init
     JIRA host (e.g. https://jira.example.org): http://www.example.org/jira
     Your JIRA username                       : johnny
     Your JIRA password                       : ************
@@ -33,19 +33,27 @@ Install via rubygems.org:
 If you want update the configuration file, e.g. changing the host, you can
 update directly the .git/config file or via the following command:
 
-    $ git-jira init -f # or --force
+    $ git-jira init -f # or --force or gj init
 
 
-## Example Scenario #1 - List branch information that have related JIRA issues:
+Check if the configuration was stored correctly.
 
-    $ git-jira list
+    $ git-jira config # or gj config
+    JIRA Host...........: https://www.example.org/jira
+    JIRA Project Key....: PROJ
+    JIRA Username.......: johnny
+
+
+## Example #1 - List branch information that have related JIRA issues:
+
+    $ git-jira list # or gj list or git-jira or gj
     Open           0% done  PROJ-123  - Implement some new feature
     Resolved     100% done  PROJ-20   - And yet another feature
     Resolved      42% done  PROJ-16   - Add /features page
 
-## Exampel Scenario #2 - Get information about the current branch
+## Exampel #2 - Get information about the current branch
 
-    $ git-jira describe
+    $ git-jira describe # or gj describe
     => Add /features page <=
 
     Issue Key...........: PROJ-123
@@ -64,11 +72,11 @@ update directly the .git/config file or via the following command:
 
     Add a page that lists all features.
 
-## Exampel Scenario #3 - Get information about a specific issue
+## Exampel #3 - Get information about a specific issue
 
 Get information about a specific issue that must not be available as branch.
 
-    $ git-jira describe -i 123 # or git-jira describe -i PROJ-123
+    $ git-jira describe -i 123 # or git-jira describe -i PROJ-123 or gj describe -i PROJ-123
     => Add /features page <=
 
     Issue Key...........: PROJ-123

data/bin/git-jira

@@ -14,25 +14,28 @@ rescue LoadError => e
   exit
 end
 
-options = { :force => false }
+options = { :force => false, :issue => nil }
 
 opt_parser = OptionParser.new do |opt|
   opt.banner = "Usage: git-jira [COMMANDS] [OPTIONS]"
+  opt.separator  "Alternative: gj [COMMANDS] [OPTIONS]"
   opt.separator  ""
   opt.separator  "Commands"
-  opt.separator  "     init [-f | --force]:     setup the current repository to be able to connect to a JIRA project"
-  opt.separator  "     list:                    returns a list of branches with related issue information"
-  opt.separator  "     describe [-i | --issue]: verbose issue information related to the current branch or specified issue"
+  opt.separator  "     init [-f | --force]        setup the current repository to be able to connect to a JIRA project"
+  opt.separator  "     config                     output the configuration fields as specified under .git/config"
+  opt.separator  "     list                       returns a list of branches with related issue information"
+  opt.separator  "     describe [-i | --issue]    verbose issue information related to the current branch or specified issue"
   opt.separator  ""
+  opt.separator  "Options"
 
   opt.on("-h", "--help", "help") do
     STDOUT.puts opt_parser
-    exit
+    exit 0
   end
 
   opt.on("-v", "--version", "print out current Version number") do
     STDOUT.puts "gitjira-#{Gitjira::VERSION}"
-    exit
+    exit 0
   end
 
   opt.on("-f", "--force", "force overwrite of .git/config [gitjira] block") do
@@ -42,29 +45,44 @@ opt_parser = OptionParser.new do |opt|
   opt.on("-i", "--issue [ISSUE]", "specify an issue number, e.g. PROJ-123 or 123") do |i|
     options[:issue] = i if i
   end
+
+  opt.separator   ""
+  opt.separator   "Copyright (C) 2013 Sigimera Ltd."
 end
 
 opt_parser.parse!
 
-case ARGV[0]
-when "init"
-  Gitjira::Setup.init(options[:force])
-when "list"
+def list
   unless Gitjira::Setup.setup?
-    STDERR.puts "[SETUP] This repository is not setup correcly, please execute: `git-jira init`"
-    exit
+    STDERR.puts "[SETUP] This repository is not setup, please execute: `git-jira init`"
+    exit 1
   end
   begin
-    Gitjira::InformationFetching.branches
+    exit Gitjira::InformationFetching.branches
   rescue => e
     STDERR.puts "[ERROR] Not able to fetch issue information from JIRA, through exception: #{e}"
+    exit 2
   end
+end
+
+case ARGV[0]
+when "init"
+  exit Gitjira::Setup.init(options[:force])
+when "config"
+  puts "JIRA Host...........: #{Gitjira::InformationFetching.host}"
+  puts "JIRA Project Key....: #{Gitjira::InformationFetching.project_key}"
+  puts "JIRA Username.......: #{Gitjira::InformationFetching.username}"
+  exit 0
+when "list"
+  list
 when "describe"
   begin
-    Gitjira::InformationFetching.describe(options[:issue])
+    exit Gitjira::InformationFetching.describe(options[:issue])
   rescue => e
     STDERR.puts "[ERROR] Not able to fetch issue information from JIRA, through exception: #{e}"
+    exit 2
   end
 else
-  STDOUT.puts opt_parser
+  list
 end
+

data/bin/gj

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+#####
+# Copyright (c) 2013 by Sigimera Ltd.
+# All rights reserved.
+#####
+require 'rubygems'
+require 'optparse'
+require 'json'
+
+begin
+  require "gitjira"
+rescue LoadError => e
+  STDERR.puts "Install the missing library:\n\t \e[0;36m$\e[m \e[0;32mgem install gitjira\e[m"
+  exit
+end
+
+options = { :force => false, :issue => nil }
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: git-jira [COMMANDS] [OPTIONS]"
+  opt.separator  "Alternative: gj [COMMANDS] [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "Commands"
+  opt.separator  "     init [-f | --force]        setup the current repository to be able to connect to a JIRA project"
+  opt.separator  "     config                     output the configuration fields as specified under .git/config"
+  opt.separator  "     list                       returns a list of branches with related issue information"
+  opt.separator  "     describe [-i | --issue]    verbose issue information related to the current branch or specified issue"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on("-h", "--help", "help") do
+    STDOUT.puts opt_parser
+    exit 0
+  end
+
+  opt.on("-v", "--version", "print out current Version number") do
+    STDOUT.puts "gitjira-#{Gitjira::VERSION}"
+    exit 0
+  end
+
+  opt.on("-f", "--force", "force overwrite of .git/config [gitjira] block") do
+    options[:force] = true
+  end
+
+  opt.on("-i", "--issue [ISSUE]", "specify an issue number, e.g. PROJ-123 or 123") do |i|
+    options[:issue] = i if i
+  end
+
+  opt.separator   ""
+  opt.separator   "Copyright (C) 2013 Sigimera Ltd."
+end
+
+opt_parser.parse!
+
+def list
+  unless Gitjira::Setup.setup?
+    STDERR.puts "[SETUP] This repository is not setup, please execute: `git-jira init`"
+    exit 1
+  end
+  begin
+    exit Gitjira::InformationFetching.branches
+  rescue => e
+    STDERR.puts "[ERROR] Not able to fetch issue information from JIRA, through exception: #{e}"
+    exit 2
+  end
+end
+
+case ARGV[0]
+when "init"
+  exit Gitjira::Setup.init(options[:force])
+when "config"
+  puts "JIRA Host...........: #{Gitjira::InformationFetching.host}"
+  puts "JIRA Project Key....: #{Gitjira::InformationFetching.project_key}"
+  puts "JIRA Username.......: #{Gitjira::InformationFetching.username}"
+  exit 0
+when "list"
+  list
+when "describe"
+  begin
+    exit Gitjira::InformationFetching.describe(options[:issue])
+  rescue => e
+    STDERR.puts "[ERROR] Not able to fetch issue information from JIRA, through exception: #{e}"
+    exit 2
+  end
+else
+  list
+end
+

data/lib/gitjira/information_fetching.rb

@@ -30,11 +30,16 @@ class Gitjira::InformationFetching
       end
     end
 
-    return nil
+    if issues_printed.size == 0
+      STDERR.puts "[Warning] No branch found that is related to an issue. You can try `git-jira describe -i ###`"
+      return 1
+    else
+      return 0
+    end
   end
 
   def self.describe(issue = nil)
-    issue = "#{self.project_key}-#{issue}" if issue and not issue.start_with?(self.project_key)
+    issue = "#{self.project_key}-#{issue}" if issue and not issue.to_s.start_with?(self.project_key)
     issue = self.extract_issue unless issue
 
     if issue
@@ -66,11 +71,15 @@ class Gitjira::InformationFetching
           puts ""
           puts "#{fields['description']}"
         end
+
+        return 0
       else
         puts "[Error] Not able to extract issue information of '#{issue}'"
+        return 2
       end
     else
-      puts "[Warning] You are currently in no branch that is related to an issue."
+      puts "[Warning] You are currently in no issue related branch. You can try `git-jira describe -i ###`"
+      return 1
     end
   end
 
@@ -117,6 +126,14 @@ class Gitjira::InformationFetching
     `git config --local --get gitjira.host`.chomp
   end
 
+  def self.username
+    encoded = self.credentials
+    credentials = Base64.strict_decode64(encoded)
+    username = credentials.split(":").first
+    encoded = credentials = nil
+    username
+  end
+
   private
   def self.fetch_issue_json(issue_name)
     jira_url = "#{self.host}rest/api/2/issue/"

data/lib/gitjira/setup.rb

@@ -5,12 +5,9 @@ class Gitjira::Setup
     if self.setup? and not force
       STDERR.puts "Repository is configured. Overwrite with:"
       STDERR.puts "\t$ git-jira init -f # or git-jira init --force."
-      return
+      return 1
     end
-    host = nil
-    username = nil
-    password = nil
-    projectkey = nil
+    host = username = password = projectkey= nil
 
     host = ask("JIRA host (e.g. https://jira.example.org): ")
     host = "#{host}/" if not host.empty? and not host.end_with?("/")
@@ -26,8 +23,10 @@ class Gitjira::Setup
       `git config --local gitjira.host #{host}`
       `git config --local gitjira.credentials #{base64.to_s}`
       `git config --local gitjira.projectkey #{projectkey}`
+      return 0
     else
       STDERR.puts "[ERROR] Please fill out all needed fields."
+      return 1
     end
 
   end

data/lib/gitjira/version.rb

@@ -1,3 +1,3 @@
 module Gitjira
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitjira
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex Oberhauser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -72,6 +72,7 @@ email:
 - alex.oberhauser@sigimera.org
 executables:
 - git-jira
+- gj
 extensions: []
 extra_rdoc_files: []
 files:
@@ -82,6 +83,7 @@ files:
 - README.md
 - Rakefile
 - bin/git-jira
+- bin/gj
 - gitjira.gemspec
 - lib/gitjira.rb
 - lib/gitjira/information_fetching.rb