capistrano-jira 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d71f8dc9b592a0718a36cf151d5148857fc29a3
-  data.tar.gz: fc9afc9620a9e4ff96feb186f6772b3c64c25482
+  metadata.gz: ca992eb03cd4d34fe9624b50930ad8d32d7fa5cc
+  data.tar.gz: 7dfd66877aab0380606fc9d067180f3437611bfd
 SHA512:
-  metadata.gz: 179755583fad4d3ce68efda8b725f6276cc34decd592516fe1dafe43e912cda59bb782db5cfbd1d34e775def6418c591c412d80f37fa388e69fefede85234035
-  data.tar.gz: e1ae6415135e0a3377020f7dd9ef5ff7689136675fc77be99e43e2124124b1a0b6a4eadcb8b59fb1c9496b1530ffc88e1e974433a9306ce97ff44f1eb4622d22
+  metadata.gz: 35d7cac445e0a03a37f8b560577bd8fc06e1b9c1ef1541182e346b8f4b49f7a858dbcf260c3e809bb1c8af9f0b2d5defe2c1030af0abf39f88e9c72cb30cde70
+  data.tar.gz: 600204753da6c7e156118f432ae7871e96876693693c9aa462001d60ad7161a90c6c7b0082accc4a2119a7bf6f450ade8d7109feb574a46fc06c6f67523325f0

data/Changelog.md

@@ -0,0 +1,13 @@
+## 0.2.0
+
+- Handle errors without exiting deployment (*wojw5*, #2)
+- Add comment on transition
+- Use capistrano output methods
+- remove rspec - there are no tests
+- remove travis CI - not needed
+- lock versions
+
+
+## 0.1.0
+
+- Initial release (*wojw5*, #1)

data/README.md

@@ -1,4 +1,3 @@
-[![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
 
@@ -29,10 +28,11 @@ 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 :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_comment_on_transition, false # default: true
+set :jira_project_key,           'PROJ' # required
 ```
 
 - Set parameters for specific environment (for example `config/deploy/staging.rb`)

data/Rakefile

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

data/capistrano-jira.gemspec

@@ -15,13 +15,11 @@ Gem::Specification.new do |spec|
 
   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_dependency 'capistrano', '~> 3.7'
+  spec.add_dependency 'jira-ruby', '~> 1.2'
 
   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

@@ -2,5 +2,17 @@ module Capistrano
   module Jira
     class TransitionError < StandardError; end
     class FinderError < StandardError; end
+
+    module ErrorHelpers
+      def error_message(e)
+        case e
+        when JIRA::HTTPError
+          r = e.response
+          "#{r.class.name}; #{r.code}: #{r.message} \n #{r.body}"
+        else
+          e.message
+        end
+      end
+    end
   end
 end

data/lib/capistrano/jira/issue_finder.rb

@@ -3,6 +3,8 @@ module Capistrano
     class IssueFinder
       attr_reader :issues
 
+      include ErrorHelpers
+
       def find!
         @issues = execute
       end
@@ -24,9 +26,7 @@ module Capistrano
       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}"
+        raise FinderError, error_message(e)
       end
     end
   end

data/lib/capistrano/jira/issue_transiter.rb

@@ -21,18 +21,31 @@ module Capistrano
       end
 
       def validate_transition
-        unless transition
-          raise TransitionError,
-                "Transition #{fetch(:jira_transition_name)} not available"
-        end
+        return if transition
+        raise TransitionError,
+              "Transition #{fetch(:jira_transition_name)} not available"
       end
 
       def execute
-        issue.transitions.build.save!(transition: { id: transition.id })
+        issue.transitions.build.save!(transition_hash)
       rescue JIRA::HTTPError => e
-        r = e.response
-        raise TransitionError,
-              "#{r.class.name}; #{r.code}: #{r.message} \n #{r.body}"
+        raise TransitionError, error_message(e)
+      end
+
+      def transition_hash
+        hash = { transition: { id: transition.id } }
+        hash.merge(comment_hash) if fetch(:jira_comment_on_transition)
+        hash
+      end
+
+      def comment_hash
+        { update:
+          { comment: [
+            { add:
+               {
+                 body: 'Issue transited automatically during deployment.'
+               } }
+          ] } }
       end
     end
   end

data/lib/capistrano/jira/version.rb

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

data/lib/capistrano/tasks/jira.rake

@@ -1,26 +1,33 @@
 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
+    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
+    set :jira_comment_on_transition, true
   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|
+    on :all do |_host|
+      info 'Looking for issues'
       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}"
+        issues = Capistrano::Jira::IssueFinder.new.find
+        issues.each do |issue|
+          begin
+            Capistrano::Jira::IssueTransiter.new(issue).transit
+            info "#{issue.key}\t\u{2713} Transited"
+          rescue Capistrano::Jira::TransitionError => e
+            warn "#{issue.key}\t\u{2717} #{e.message}"
+          end
+        end
+      rescue Capistrano::Jira::FinderError => e
+        error "#{e.class} #{e.message}"
       end
     end
   end
@@ -28,8 +35,10 @@ namespace :jira do
   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)
+    required_params =
+      %i(jira_username jira_password jira_site jira_project_key
+         jira_status_name jira_transition_name jira_comment_on_transition)
+
     puts '=> Required params'
     required_params.each do |param|
       print "#{param} = "

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-jira
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wojciech Widenka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-11 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: jira-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !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
@@ -89,13 +75,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- Changelog.md
 - Gemfile
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - capistrano-jira.gemspec
+- lib/capistrano-jira.rb
 - lib/capistrano/jira.rb
 - lib/capistrano/jira/errors.rb
 - lib/capistrano/jira/issue_finder.rb

data/.travis.yml

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

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

@@ -1,8 +0,0 @@
-#!/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