capistrano-jira 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d71f8dc9b592a0718a36cf151d5148857fc29a3
+  data.tar.gz: fc9afc9620a9e4ff96feb186f6772b3c64c25482
+SHA512:
+  metadata.gz: 179755583fad4d3ce68efda8b725f6276cc34decd592516fe1dafe43e912cda59bb782db5cfbd1d34e775def6418c591c412d80f37fa388e69fefede85234035
+  data.tar.gz: e1ae6415135e0a3377020f7dd9ef5ff7689136675fc77be99e43e2124124b1a0b6a4eadcb8b59fb1c9496b1530ffc88e1e974433a9306ce97ff44f1eb4622d22

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-jira.gemspec
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+[![Build Status](https://travis-ci.org/wojw5/capistrano-jira.svg?branch=master)](https://travis-ci.org/wojw5/capistrano-jira)
+[![Code Climate](https://codeclimate.com/github/wojw5/capistrano-jira/badges/gpa.svg)](https://codeclimate.com/github/wojw5/capistrano-jira)
+# Capistrano::Jira
+
+Transit JIRA issues automatically after deployment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-jira'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-jira
+
+## Usage
+
+- Require library in `Capfile`
+```ruby
+require 'capistrano/jira'
+```
+
+- Set general parameters in `config/deploy.rb`
+```ruby
+set :jira_username,    'john.doe@exalmple.com' # default: ENV['CAPISTRANO_JIRA_USERNAME']
+set :jira_password,    'p@55w0rD' # default: ENV['CAPISTRANO_JIRA_PASSWORD']
+set :jira_site,        'https://example.atlassian.net' # default: ENV['CAPISTRANO_JIRA_SITE']
+set :jira_project_key, 'PROJ' # required
+```
+
+- Set parameters for specific environment (for example `config/deploy/staging.rb`)
+```ruby
+set :jira_status_name,     'QA passed' # required; name of status from which issues should be transited
+set :jira_transition_name, 'Deploy to staging' # required; name of transition that should be executed
+set :jira_filter_jql,      'component = Backend' # optional; additional JQL filter to scope issues
+```
+
+Then while running deployment you should see transitioned issues.
+
+When transition fails for some reason (for example HTTP Error) it will inform you but NOT fail whole deployment.
+
+## Checking setup
+
+To check if setup is proper or diagnose a problem run for your environment
+```
+cap staging jira:check
+```
+
+Proper output will be similar to this:
+```
+=> Required params
+jira_username = wojtek@codegarden.online
+jira_password = **********
+jira_site = https://example.atlassian.net
+jira_project_key = PROJ
+jira_status_name = QA passed
+jira_transition_name = Deploy to staging
+<= OK
+=> Checking connection
+<= OK
+=> Checking for given project key
+<= OK
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-jira.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'capistrano/jira'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-jira.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/jira/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'capistrano-jira'
+  spec.version  = Capistrano::Jira::VERSION
+  spec.authors  = ['Wojciech Widenka']
+  spec.email    = ['wojtek@codegarden.online']
+
+  spec.summary  =
+    'Automated JIRA issues transitions after deployment with Capistrano'
+  spec.homepage = 'https://github.com/wojw5/capistrano-jira'
+
+  spec.files = `git ls-files -z`
+               .split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano'
+  spec.add_dependency 'jira-ruby'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/capistrano/jira/errors.rb

@@ -0,0 +1,6 @@
+module Capistrano
+  module Jira
+    class TransitionError < StandardError; end
+    class FinderError < StandardError; end
+  end
+end

data/lib/capistrano/jira/issue_finder.rb

@@ -0,0 +1,33 @@
+module Capistrano
+  module Jira
+    class IssueFinder
+      attr_reader :issues
+
+      def find!
+        @issues = execute
+      end
+
+      def find
+        @issues ||= execute
+      end
+
+      private
+
+      def jql
+        [
+          "project = #{fetch(:jira_project_key)}",
+          "status = #{fetch(:jira_status_name)}",
+          fetch(:jira_filter_jql)
+        ].compact.join(' AND ')
+      end
+
+      def execute
+        Jira.client.Issue.jql(jql, fields: ['status'], max_results: 1_000_000)
+      rescue JIRA::HTTPError => e
+        r = e.response
+        raise FinderError,
+              "#{r.class.name}; #{r.code}: #{r.message} \n #{r.body}"
+      end
+    end
+  end
+end

data/lib/capistrano/jira/issue_transiter.rb

@@ -0,0 +1,39 @@
+module Capistrano
+  module Jira
+    class IssueTransiter
+      attr_reader :issue
+
+      def initialize(issue)
+        @issue = issue
+      end
+
+      def transit
+        validate_transition
+        execute
+      end
+
+      private
+
+      def transition
+        @transition ||= issue.transitions.all.find do |t|
+          t.attrs['name'].casecmp(fetch(:jira_transition_name)).zero?
+        end
+      end
+
+      def validate_transition
+        unless transition
+          raise TransitionError,
+                "Transition #{fetch(:jira_transition_name)} not available"
+        end
+      end
+
+      def execute
+        issue.transitions.build.save!(transition: { id: transition.id })
+      rescue JIRA::HTTPError => e
+        r = e.response
+        raise TransitionError,
+              "#{r.class.name}; #{r.code}: #{r.message} \n #{r.body}"
+      end
+    end
+  end
+end

data/lib/capistrano/jira/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Jira
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/capistrano/jira.rb

@@ -0,0 +1,19 @@
+require 'capistrano/jira/version'
+require 'capistrano/jira/errors'
+require 'capistrano/jira/issue_finder'
+require 'capistrano/jira/issue_transiter'
+require 'jira-ruby'
+
+module Capistrano
+  module Jira
+    def self.client
+      ::JIRA::Client.new(username: fetch(:jira_username),
+                         password: fetch(:jira_password),
+                         site: fetch(:jira_site),
+                         context_path: '',
+                         auth_type: :basic)
+    end
+  end
+end
+
+load File.expand_path('../tasks/jira.rake', __FILE__)

data/lib/capistrano/tasks/jira.rake

@@ -0,0 +1,59 @@
+namespace :load do
+  task :defaults do
+    set :jira_username,        ENV['CAPISTRANO_JIRA_USERNAME']
+    set :jira_password,        ENV['CAPISTRANO_JIRA_PASSWORD']
+    set :jira_site,            ENV['CAPISTRANO_JIRA_SITE']
+    set :jira_project_key,     nil
+    set :jira_status_name,     nil
+    set :jira_transition_name, nil
+    set :jira_filter_jql,      nil
+  end
+end
+
+namespace :jira do
+  desc 'Find and transit possible JIRA issues'
+  task :find_and_transit do |_t|
+    puts 'Looking for issues'
+    issues = Capistrano::Jira::IssueFinder.new.find
+    issues.each do |issue|
+      begin
+        Capistrano::Jira::IssueTransiter.new(issue).transit
+        puts "#{issue.key}\t\u{2713} Transited"
+      rescue Capistrano::Jira::TransitionError => e
+        puts "#{issue.key}\t\u{2717} #{e.message}"
+      end
+    end
+  end
+
+  desc 'Check JIRA setup'
+  task :check do
+    errored = false
+    required_params = %i(jira_username jira_password jira_site jira_project_key
+                         jira_status_name jira_transition_name)
+    puts '=> Required params'
+    required_params.each do |param|
+      print "#{param} = "
+      if fetch(param).nil? || fetch(param) == ''
+        puts '!!!!!! EMPTY !!!!!!'
+        errored = true
+      else
+        puts param == :jira_password ? '**********' : fetch(param)
+      end
+    end
+    raise StandardError, 'Not all required parameters are set' if errored
+    puts '<= OK'
+
+    puts '=> Checking connection'
+    projects = ::Capistrano::Jira.client.Project.all
+    puts '<= OK'
+
+    puts '=> Checking for given project key'
+    exist = projects.any? { |project| project.key == fetch(:jira_project_key) }
+    unless exist
+      raise StandardError, "Project #{fetch(:jira_project_key)} not found"
+    end
+    puts '<= OK'
+  end
+
+  after 'deploy:finished', 'jira:find_and_transit'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-jira
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wojciech Widenka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jira-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- wojtek@codegarden.online
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-jira.gemspec
+- lib/capistrano/jira.rb
+- lib/capistrano/jira/errors.rb
+- lib/capistrano/jira/issue_finder.rb
+- lib/capistrano/jira/issue_transiter.rb
+- lib/capistrano/jira/version.rb
+- lib/capistrano/tasks/jira.rake
+homepage: https://github.com/wojw5/capistrano-jira
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Automated JIRA issues transitions after deployment with Capistrano
+test_files: []