capistrano-committed 0.0.3 → 0.0.4

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.10.6
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - rbx-2
+addons:
+  code_climate:
+    repo_token: c19f4a2a864567e4dbf3e325b4423d9478c3bf025d9e3f85c6e2ffc0c9fb960f
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in capistrano-release-log.gemspec
 gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end

data/README.md

@@ -1,5 +1,16 @@
+<div align="center">
+  <a href="https://github.com/sambauers/capistrano-committed"><img width="136" src="https://github.com/sambauers/capistrano-committed/raw/master/icons/capricorn.png" alt="Capistrano Committed logo" /></a>
+</div>
+
 # Capistrano Committed
 
+[![Gem Version](https://badge.fury.io/rb/capistrano-committed.svg)](https://badge.fury.io/rb/capistrano-committed)
+[![Build Status](https://travis-ci.org/sambauers/capistrano-committed.svg?branch=master)](https://travis-ci.org/sambauers/capistrano-committed)
+[![Test Coverage](https://codeclimate.com/github/sambauers/capistrano-committed/badges/coverage.svg)](https://codeclimate.com/github/sambauers/capistrano-committed/coverage)
+[![Code Climate](https://codeclimate.com/github/sambauers/capistrano-committed/badges/gpa.svg)](https://codeclimate.com/github/sambauers/capistrano-committed)
+[![Issue Count](https://codeclimate.com/github/sambauers/capistrano-committed/badges/issue_count.svg)](https://codeclimate.com/github/sambauers/capistrano-committed)
+[![Dependency Status](https://gemnasium.com/sambauers/capistrano-committed.svg)](https://gemnasium.com/sambauers/capistrano-committed)
+
 Capistrano Committed is an extension to Capistrano 3 which helps to determine what you are about to deploy.
 
 It creates a report, which lets you know which GitHub commits and pull requests are not yet deployed to the target stage (server).
@@ -99,6 +110,9 @@ set :committed_issue_match, '\[\s?([A-Z0-9]+\-[0-9]+)\s?\]'
 # "%s" will be replaced with the issue number. Setting this to `nil` will also
 # disable issue matching altogether.
 set :committed_issue_url, 'https://example.jira.com/browse/%s'
+
+# Register deployments in GitHub via the GitHub Deployments API
+set :committed_deployments, false
 ```
 
 Once your required settings are all in place, you can generate a report by running:
@@ -106,3 +120,14 @@ Once your required settings are all in place, you can generate a report by runni
 ```shell
 $ cap <stage> committed:generate
 ```
+
+## What's with the unicorn?
+
+<div align="center">
+  <a href="https://github.com/sambauers/capistrano-committed"><img width="640" src="https://github.com/sambauers/capistrano-committed/raw/master/icons/capricorn_equation.png" alt="Capistrano + GitHub API gem = Capistrano Committed gem" /></a>
+</div>
+
+* [Capistrano](http://capistranorb.com)
+* [GitHub API gem](https://github.com/peter-murach/github)
+
+

data/lib/capistrano/committed/github_api.rb

@@ -4,65 +4,122 @@ module Capistrano
   module Committed
     class GithubApi
       def initialize(config_options = {})
-        raise TypeError, '`initialize` requires a hash to be passed as the first and only argument' unless config_options.is_a?(Hash)
+        validate('config_options', config_options, Hash, __callee__)
 
-        config_options.merge!({
-          :adapter => :net_http,
-          :ssl => {:verify => false},
-          :per_page => 100,
-          :user_agent => 'Committed Ruby Gem (via Github API Ruby Gem)'
-        })
+        options = { adapter: :net_http,
+                    ssl: { verify: false },
+                    per_page: 100,
+                    user_agent: 'Committed Ruby Gem (via Github API Ruby Gem)' }
 
-        @client = ::Github.new config_options
+        options.merge! config_options
+
+        @client = ::Github.new options
+      end
+
+      def client
+        @client
       end
 
       def get_commit(user, repo, sha)
-        validate_user_and_repo(user, repo)
-        raise TypeError, sprintf('`%s` requires a valid commit SHA.', __callee__) unless sha.is_a?(String)
+        validate_user_and_repo(user, repo, __callee__)
+        validate('sha', sha, String, __callee__)
 
-        begin
-          @client.repos.commits.get(:user => user, :repo => repo, :sha => sha)
-        rescue ::Github::Error::GithubError => e
-          rescue_github_errors(e)
+        api_call do
+          @client.repos.commits.get(user: user,
+                                    repo: repo,
+                                    sha:  sha)
         end
       end
 
       def get_commits_since(user, repo, date, branch = 'master')
-        validate_user_and_repo(user, repo)
+        validate_user_and_repo(user, repo, __callee__)
         date = Time.parse(date) if date.is_a?(String)
-        raise TypeError, sprintf('`%s` requires a valid date.', __callee__) unless date.is_a?(Time)
-        raise TypeError, sprintf('`%s` requires a valid branch.', __callee__) unless branch.is_a?(String)
+        validate('date', date, Time, __callee__)
+        validate('branch', branch, String, __callee__)
 
-        begin
-          @client.repos.commits.list(:user => user, :repo => repo, :sha => branch, :since => date.iso8601)
-        rescue ::Github::Error::GithubError => e
-          rescue_github_errors(e)
+        api_call do
+          @client.repos.commits.list(user:  user,
+                                     repo:  repo,
+                                     sha:   branch,
+                                     since: date.iso8601)
         end
       end
 
       def get_pull_request(user, repo, number)
-        validate_user_and_repo(user, repo)
-        raise TypeError, sprintf('`%s` requires a valid pull request number.', __callee__) unless number.is_a?(Integer)
-
-        begin
-          info = @client.pull_requests.get(:user => user, :repo => repo, :number => number)
-          commits = @client.pull_requests.commits(:user => user, :repo => repo, :number => number)
-          return {:info => info, :commits => commits}
-        rescue ::Github::Error::GithubError => e
-          rescue_github_errors(e)
+        validate_user_and_repo(user, repo, __callee__)
+        validate('number', number, Integer, __callee__)
+
+        api_call do
+          info = @client.pull_requests.get(user:    user,
+                                           repo:    repo,
+                                           number:  number)
+
+          commits = @client.pull_requests.commits(user:   user,
+                                                  repo:   repo,
+                                                  number: number)
+
+          return { info: info, commits: commits }
+        end
+      end
+
+      def register_deployment(user, repo, stage, branch = 'master')
+        validate_user_and_repo(user, repo, __callee__)
+        validate('stage', stage, String, __callee__)
+        validate('branch', branch, String, __callee__)
+
+        api_call do
+          @client.repos.deployments.create(user:              user,
+                                           repo:              repo,
+                                           environment:       stage,
+                                           ref:               branch,
+                                           auto_merge:        false,
+                                           required_contexts: [])
         end
       end
 
-      def validate_user_and_repo(user, repo)
-        raise TypeError, sprintf('`%s` requires a valid GitHub user.', __caller__) unless user.is_a?(String)
-        raise TypeError, sprintf('`%s` requires a valid GitHub repository.', __caller__) unless repo.is_a?(String)
+      def register_deployment_status(user, repo, id, state)
+        validate_user_and_repo(user, repo, __callee__)
+        validate('id', id, Integer, __callee__)
+
+        valid_states = %w(pending success error failure)
+        state = state.to_s
+        unless valid_states.include?(state)
+          message = t('committed.error.helpers.valid_param',
+                      method: __callee__,
+                      param: 'state')
+          fail TypeError, message
+        end
+
+        api_call do
+          @client.repos.deployments.create_status(user:   user,
+                                                  repo:   repo,
+                                                  id:     id,
+                                                  state:  state)
+        end
+      end
+
+      private
+
+      def validate(param, value, type, method)
+        return if value.is_a?(type)
+        message = t('committed.error.helpers.valid_param',
+                    method: method,
+                    param: param)
+        fail TypeError, message
+      end
+
+      def validate_user_and_repo(user, repo, method)
+        validate('GitHub user', user, String, method)
+        validate('GitHub repository', repo, String, method)
       end
 
-      def rescue_github_errors(e)
+      def api_call
+        yield
+      rescue ::Github::Error::GithubError => e
         if e.is_a? ::Github::Error::ServiceError
-          raise e, 'There seems to be a problem with the GitHub service.'
+          raise e, t('committed.error.helpers.github_service_error')
         elsif e.is_a? ::Github::Error::ClientError
-          raise e, 'There seems to be a problem with the request that was made to GitHub, check that your settings are correct.'
+          raise e, t('committed.error.helpers.github_client_error')
         end
       end
     end

data/lib/capistrano/committed/i18n.rb

@@ -2,6 +2,11 @@ require 'i18n'
 
 en = {
   error: {
+    helpers: {
+      valid_param:          '`%{method}` requires a valid %{param}.',
+      github_service_error: 'There seems to be a problem with the GitHub service.',
+      github_client_error:  'There seems to be a problem with the request that was made to GitHub, check that your settings are correct.'
+    },
     prerequisites: {
       nil:                      '`:%{variable}` variable is `nil`, it needs to contain the %{name} name.',
       empty:                    '`:%{variable}` variable is empty, it needs to contain the %{name} name.',

data/lib/capistrano/committed/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Committed
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/lib/capistrano/committed.rb

@@ -1,22 +1,43 @@
-require "capistrano/committed/version"
+require 'capistrano/committed/version'
 require 'capistrano/committed/i18n'
-require "capistrano/committed/github_api"
+require 'capistrano/committed/github_api'
 
 module Capistrano
   module Committed
     class << self
-      def scan_for_issues(pattern, string)
-        raise TypeError, sprintf('`%s` requires a valid pattern.', __callee__) unless pattern.is_a?(String) || pattern.is_a?(Regexp)
-        raise TypeError, sprintf('`%s` requires a valid string.', __callee__) unless pattern.is_a?(String)
+      def get_issue_urls(issue_pattern, url_pattern, message)
+        fail TypeError, t('committed.error.helpers.valid_param',
+                          method: __callee__,
+                          param: 'issue_pattern') unless
+                            issue_pattern.is_a?(String) ||
+                            issue_pattern.is_a?(Regexp)
 
-        matches = Regexp.new(pattern).match(string)
-        return unless matches && matches[1]
-        matches = matches.to_a
-        matches.shift
-        matches
+        fail TypeError, t('committed.error.helpers.valid_param',
+                          method: __callee__,
+                          param: 'url_pattern') unless
+                            url_pattern.is_a?(String)
+
+        fail TypeError, t('committed.error.helpers.valid_param',
+                          method: __callee__,
+                          param: 'message') unless
+                            message.is_a?(String)
+
+        matches = message.scan(Regexp.new(issue_pattern))
+        return [] unless matches
+        matches.map { |m| format(url_pattern, m[0]) }
+      end
+
+      def format_issue_urls(urls, pad = '')
+        return [] if urls.nil? || urls.empty?
+        output = []
+        output << format('%s   %s', pad, t('committed.output.issue_links'))
+        urls.each do |url|
+          output << format('%s   - %s', pad, url)
+        end
+        output << format('%s', pad)
       end
     end
   end
 end
 
-load File.expand_path("../tasks/committed.rake", __FILE__)
+load File.expand_path('../tasks/committed.rake', __FILE__)