RubyGems - jira - Versions diffs - 0.1.0 - Mend

jira 0.1.0

Files changed (16) hide show

data/.document ADDED

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore ADDED

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+## TEXTMATE
+*.tmproj
+tmtags
+## EMACS
+*~
+\#*
+.\#*
+## VIM
+*.swp
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+## PROJECT::SPECIFIC

data/LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2009 chrislo
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc ADDED

@@ -0,0 +1,29 @@
+= jira
+A command line interface to the Jira issue tracking system.
+To use, create a '.jira' YAML file in your home directory. For example:
+   :jira_base: https://jira.your.domain
+   :pem: ~/yourcert.pem
+The 'pem' parameter is optional, but required if your jira
+installation uses SSL authentication. If you connect to Jira through a
+proxy set the HTTP_PROXY environment variable.
+To get a list of unopened tickets assigned to you:
+   $ jira list
+== Note on Patches/Pull Requests
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+* Send me a pull request. Bonus points for topic branches.
+== Copyright
+Copyright (c) 2009 chrislo. See LICENSE for details.

data/Rakefile ADDED

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jira"
+    gem.summary = %Q{A command line interface to the JIRA issue tracking system}
+    gem.description = %Q{A command line interface to the JIRA issue tracking system}
+    gem.email = "chris.lowis@gmail.com"
+    gem.homepage = "http://github.com/chrislo/jira"
+    gem.authors = ["chrislo"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "fakeweb", ">= 1.2.7"
+    gem.add_dependency "rest-client", ">= 1.0.3"
+    gem.add_dependency "xml-simple", ">= 1.0.12"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+task :spec => :check_dependencies
+task :default => :spec
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jira #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 0.1.0

data/bin/jira ADDED

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+#   require 'jira'
+require File.dirname(__FILE__) + '/../lib/jira'
+Jira::CLI.execute

data/jira.gemspec ADDED

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{jira}
+  s.version = ""
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["chrislo"]
+  s.date = %q{2009-11-16}
+  s.description = %q{TODO: longer description of your gem}
+  s.email = %q{chris.lowis@bbc.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "lib/jira.rb",
+     "spec/jira_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/chrislo/jira}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{TODO: one-line summary of your gem}
+  s.test_files = [
+    "spec/jira_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end

data/lib/jira.rb ADDED

@@ -0,0 +1,5 @@
+require 'pathname'
+dir = Pathname(__FILE__).dirname.expand_path
+require dir + 'jira/issue'
+require dir + 'jira/cli'

data/lib/jira/cli.rb ADDED

@@ -0,0 +1,65 @@
+require 'optparse'
+module Jira
+  class CLI
+    attr_reader :action, :options, :args
+    def self.execute
+      parse(ARGV).execute!
+    end
+    def self.parse(args)
+      cli = new(args)
+      cli.parse_options!
+      cli.load_options_from_file
+      cli
+    end
+    def initialize(args)
+      @args = args.dup
+    end
+    def execute!
+      case action
+      when 'list':
+          handle_ticket_list
+      else
+        puts 'not a command'
+      end
+    end
+    def handle_ticket_list
+      issues = Jira::Issue.new(@options).list_all_open_assigned_issues
+      puts issues
+    end
+    def parse_options!
+      if args.empty?
+        warn "Please specify at least one action to execute."
+        puts " list"
+        exit
+      end
+      @action = args.first
+    end
+    def load_options_from_file
+      options_file = File.join(ENV['HOME'],'.jira')
+      if File.exists?(options_file)
+        loaded_options = YAML.load_file(File.join(ENV['HOME'],'.jira'))
+      else
+        abort "You need a ~/.jira"
+      end
+      @options = {}
+      @options[:jira_base] = loaded_options[:jira_base]
+      if loaded_options.has_key? :pem
+        pem_contents = File.read(File.expand_path(loaded_options[:pem]))
+        @options[:ssl_client_cert]  =  OpenSSL::X509::Certificate.new(pem_contents)
+        @options[:ssl_client_key]   =  OpenSSL::PKey::RSA.new(pem_contents)
+        @options[:verify_ssl]       =  OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+  end
+end

data/lib/jira/issue.rb ADDED

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'rest_client'
+require 'xmlsimple'
+require 'ostruct'
+module Jira
+  class Issue
+    def initialize(options = nil)
+      @resource = rest_resource(options)
+    end
+    def rest_resource(options)
+      RestClient.proxy = ENV['http_proxy']
+      @resource = RestClient::Resource.new(options[:jira_base], options)
+    end
+    def find_all_open_assigned_issues
+      res = @resource['sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?resolution=-1&assigneeSelect=issue_current_user'].get
+      doc = XmlSimple.xml_in res.to_s
+      open_issues = doc['channel'].first['item']
+      issues = open_issues.map {|i| OpenStruct.new(i)}
+    end
+    def list_all_open_assigned_issues
+      issues = find_all_open_assigned_issues
+      issues.map{|i| "* #{i.title}"}.join("\n")
+    end
+  end
+end

data/spec/fixtures/issues.xml ADDED

@@ -0,0 +1,155 @@
+<!--  RSS generated by JIRA (Enterprise Edition, Version: 3.13-#330) at Wed Nov 18 23:15:44 GMT 2009 -->
+<!-- If you wish to do custom client-side styling of RSS, uncomment this:
+<?xml-stylesheet href="https://jira.your.domain:443/styles/jiraxml2html.xsl" type="text/xsl"?>
+-->
+<rss version="0.92" >
+<channel>
+    <title>Your JIRA</title>
+    <link>https://jira.your.domain:443/secure/IssueNavigator.jspa?reset=true&amp;resolution=-1&amp;assigneeSelect=issue_current_user&amp;sorter/field=priority&amp;sorter/order=DESC</link>
+    <description>An XML representation of a search request</description>
+    <language>en-gb</language>     <issue start="0" end="2" total="2" />     <build-info>
+        <version>3.13</version>
+        <build-number>330</build-number>
+        <build-date>27-08-2008</build-date>
+        <edition>Enterprise</edition>
+    </build-info>
+<item>
+<title>[TST-14301] Test</title>
+<link>https://jira.your.domain:443/browse/TST-14301</link>
+                    <description></description>
+                <environment></environment>
+            <key id="48203">TST-14301</key>
+        <summary>Test</summary>
+        <type id="18" iconUrl="https://jira.your.domain:443https://confluence.your.domain/download/attachments/6162113/application_go.png">Change</type>
+            <priority id="5" iconUrl="https://jira.your.domain:443https://confluence.your.domain/download/attachments/6162113/error.png">Unknown</priority>
+        <status id="1" iconUrl="https://jira.your.domain:443/images/icons/status_open.gif">Open</status>
+                        <resolution id="-1">Unresolved</resolution>
+                        <assignee username="chris.lowis">Chris Lowis</assignee>
+                        <reporter username="chris.lowis">Chris Lowis</reporter>
+    <created>Wed, 18 Nov 2009 20:57:09 +0000 (GMT)</created>
+    <updated>Wed, 18 Nov 2009 20:57:15 +0000 (GMT)</updated>
+            <due></due>
+            <votes>0</votes>
+    <attachments>
+        </attachments>
+    <subtasks>
+        </subtasks>
+            <customfields>
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10310" key="com.atlassian.jira.plugin.system.customfieldtypes:multiselect">
+                    <customfieldname>Group assignee</customfieldname>
+                    <customfieldvalues>
+                            <customfieldvalue><![CDATA[Not assigned]]></customfieldvalue>
+                    </customfieldvalues>
+                </customfield>
+                                                                                                                                <customfield id="customfield_10272" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
+                    <customfieldname>Change Type</customfieldname>
+                    <customfieldvalues>
+                        <customfieldvalue><![CDATA[Managed]]></customfieldvalue>
+                    </customfieldvalues>
+                </customfield>
+                                                                                                                                                                                                                                                                                                <customfield id="customfield_10297" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
+                    <customfieldname>Tech kick-off</customfieldname>
+                    <customfieldvalues>
+                        <customfieldvalue><![CDATA[No]]></customfieldvalue>
+                    </customfieldvalues>
+                </customfield>
+                                                                                                                                                                                                                                                                                                                                                                                                                    </customfields>
+</item>
+<item>
+<title>[TST-14302] another ticket</title>
+<link>https://jira.your.domain:443/browse/TST-14302</link>
+                    <description></description>
+                <environment></environment>
+            <key id="48206">TST-14302</key>
+        <summary>another ticket</summary>
+        <type id="18" iconUrl="https://jira.your.domain:443https://confluence.your.domain/download/attachments/6162113/application_go.png">Change</type>
+            <priority id="5" iconUrl="https://jira.your.domain:443https://confluence.your.domain/download/attachments/6162113/error.png">Unknown</priority>
+        <status id="1" iconUrl="https://jira.your.domain:443/images/icons/status_open.gif">Open</status>
+                        <resolution id="-1">Unresolved</resolution>
+                        <assignee username="chris.lowis">Chris Lowis</assignee>
+                        <reporter username="chris.lowis">Chris Lowis</reporter>
+    <created>Wed, 18 Nov 2009 23:14:54 +0000 (GMT)</created>
+    <updated>Wed, 18 Nov 2009 23:15:00 +0000 (GMT)</updated>
+            <due></due>
+            <votes>0</votes>
+    <attachments>
+        </attachments>
+    <subtasks>
+        </subtasks>
+            <customfields>
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10310" key="com.atlassian.jira.plugin.system.customfieldtypes:multiselect">
+                    <customfieldname>Group assignee</customfieldname>
+                    <customfieldvalues>
+                            <customfieldvalue><![CDATA[Not assigned]]></customfieldvalue>
+                    </customfieldvalues>
+                </customfield>
+                                                                                                                                <customfield id="customfield_10272" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
+                    <customfieldname>Change Type</customfieldname>
+                    <customfieldvalues>
+                        <customfieldvalue><![CDATA[Managed]]></customfieldvalue>
+                    </customfieldvalues>
+                </customfield>
+                                                                                                                                                                                                                                                                                                <customfield id="customfield_10297" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
+                    <customfieldname>Tech kick-off</customfieldname>
+                    <customfieldvalues>
+                        <customfieldvalue><![CDATA[No]]></customfieldvalue>
+                    </customfieldvalues>
+                </customfield>
+                                                                                                                                                                                                                                                                                                                                                                                                                    </customfields>
+</item>
+</channel>
+</rss>

data/spec/jira/issue_spec.rb ADDED

@@ -0,0 +1,32 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+module Jira
+  describe Issue do
+    before(:each) do
+      options[:jira_base] = 'https://my.jira'
+      FakeWeb.allow_net_connect = false
+      FakeWeb.register_uri(:get,
+                           "#{options[:jira_base]}/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?resolution=-1&assigneeSelect=issue_current_user",
+                           :body => File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures', 'issues.xml'))))
+      @ji = Jira::Issue.new(options)
+    end
+    describe "initialize" do
+    end
+    describe "find_all_open_assigned_issues" do
+      it "should return a list of open issues" do
+        issues = @ji.find_all_open_assigned_issues
+        issues.map {|i| i.title}.flatten.should include('[TST-14301] Test')
+      end
+    end
+    describe "list all open assigned issues" do
+      it "should give a formated list of issue titles" do
+        @ji.stub!(:find_all_open_assigned_issues).
+          and_return([OpenStruct.new(:title => "An issue"),OpenStruct.new(:title => "A second issue")])
+        @ji.list_all_open_assigned_issues.should == "* An issue\n* A second issue"
+      end
+    end
+  end
+end

data/spec/spec.opts ADDED

	@@ -0,0 +1 @@
1	+ --color

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'spec/autorun'
+require 'jira'
+require 'rubygems'
+require 'fakeweb'
+Spec::Runner.configure do |config|
+end

metadata ADDED

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: jira
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- chrislo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-12-06 00:00:00 +00:00
+default_executable: jira
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.9
+    version:
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  type: :development
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+    version:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+    version:
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+    version:
+description: A command line interface to the JIRA issue tracking system
+email: chris.lowis@gmail.com
+executables:
+- jira
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/jira
+- jira.gemspec
+- lib/jira.rb
+- lib/jira/cli.rb
+- lib/jira/issue.rb
+- spec/fixtures/issues.xml
+- spec/jira/issue_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/chrislo/jira
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: A command line interface to the JIRA issue tracking system
+test_files:
+- spec/jira/issue_spec.rb
+- spec/spec_helper.rb