capistrano-ci 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4bb2f3e598f26beed767fa2053561d13f87924f
+  data.tar.gz: 51f561d4c7e7353439e07062cdeb1038fd4d3911
+SHA512:
+  metadata.gz: 35753365238dae3e5dc0764da0b78798d85ee9ad52ffdbd86f7751e74128904417ee18c14c5b4f8058251ee3fbe429da5d2604a7dde35aab6f40e8ba9c7dde5a
+  data.tar.gz: 287ea3753b4b0560dbe4256669d6c62799bc4d27fa4b2bc2cd08baaf2e431776fa280a0952202b8c958403ea9c6822402c1c220845b730233f87d6446fd0d652

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+notifications:
+  email: false
+branches:
+  only:
+    - master
+    - development
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Railsware LLC
+
+MIT License
+
+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.md

@@ -0,0 +1,76 @@
+# Capistrano::Ci
+[![Build Status](https://travis-ci.org/railsware/capistrano-ci.png)](https://travis-ci.org/railsware/capistrano-ci)
+
+
+## Introduction
+
+capistrano-ci is extension for capistrano that allows you to check status of your repository before deployment. Currently it supports:
+
+  * travis-ci: Open Source and Pro versions ([https://travis-ci.org](https://travis-ci.org) or [https://travis-ci.com](https://travis-ci.com))
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-ci'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-ci
+
+Add to your Capfile:
+    
+    require 'capistrano/ci/recipies'
+
+## Configuration
+
+Variables list: 
+
+  * :ci_client (required) - supports 'travis' or 'travis_pro';
+  * :ci_repository (required) - organization or user name and repository name on github;
+  * :ci_access_token(required only for 'travis_pro' ci client) - access token for Pro account on Travis-CI.
+
+### Open Source Projects
+
+Setup ci_client and ci_repository variables in your deployment script: 
+
+     set(:ci_client){ "travis" }
+     set(:ci_repository){ "organisation-or-user/repository-name" }
+
+### Pro Account of Travis-CI:
+
+Additional to ci_client and ci_repository setup ci_access_token: 
+
+     set(:ci_client){ "travis_pro" }
+     set(:ci_repository){ "organisation-or-user/repository-name" }
+     set(:ci_access_token){ "your-pro-access-token" }
+
+Read explaination [how to obtain Travis-CI access token](http://railsware.com/blog/2013/09/10/capistrano-recipe-for-checking-travis-ci-build-status/). To have more information about Travis-CI access token follow [this blog post](http://about.travis-ci.org/blog/2013-01-28-token-token-token). 
+
+### Enable ci:verify task:
+
+     before 'deploy' do
+       ci.verify
+     end
+
+     # or in case of using capistrano-patch: 
+     before 'patch:create' do
+       ci.verify
+     end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2013 Railsware LLC. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/capistrano-ci.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/ci/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-ci"
+  spec.version       = Capistrano::Ci::VERSION
+  spec.authors       = ["paladiy"]
+  spec.email         = ["olexanderpaladiy@gmail.com"]
+  spec.description   = %q{Capistrano recipe for checking CI build status}
+  spec.summary       = %q{Capistrano recipe for checking CI build status of your repo}
+  spec.homepage      = "https://github.com/railsware/capistrano-ci"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "simplecov", "~> 0.7.1"
+  spec.add_development_dependency "vcr", "~> 2.6.0"
+  spec.add_development_dependency "webmock", "~> 1.14.0"
+
+  spec.add_runtime_dependency "capistrano", ">=2.5.5"
+  spec.add_runtime_dependency "httparty"
+
+end

data/lib/capistrano/ci/client.rb

@@ -0,0 +1,37 @@
+module Capistrano
+  module CI
+    class Client
+      SETTINGS = [:ci_client, :ci_repository, :ci_access_token]
+
+      class NotFound < StandardError; end
+
+      def initialize(config)
+        @config = SETTINGS.inject({}) do |result, key|
+          result[key] = config[key] if config.exists?(key)
+          result
+        end
+      end
+
+      def state(branch)
+        client.state(branch)
+      end
+
+      def passed?(branch)
+        client.passed?(branch)
+      end
+
+      private
+
+      def client
+        @client ||= case @config[:ci_client]
+        when "travis"
+          Capistrano::CI::Clients::Travis.new @config[:ci_repository]
+        when "travis_pro"
+          Capistrano::CI::Clients::TravisPro.new @config[:ci_repository], @config[:ci_access_token]
+        else
+          raise NotFound, "can't find CI client with name '#{@config[:ci_client]}'"
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ci/clients/base.rb

@@ -0,0 +1,34 @@
+require "httparty"
+
+module Capistrano
+  module CI
+    module Clients
+      class ResponseError < StandardError; end
+
+      class Base
+        include HTTParty
+
+        def passed?(branch)
+          raise NotImplementedError
+        end
+
+        def state(branch)
+          raise NotImplementedError
+        end
+
+        private
+
+        def get(url)
+          response = self.class.get(url)
+
+          if response.response.code == "200"
+            response.parsed_response
+          else
+            raise Capistrano::CI::Clients::ResponseError
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/ci/clients/travis.rb

@@ -0,0 +1,36 @@
+module Capistrano
+  module CI
+    module Clients
+      class Travis < Base
+        base_uri 'https://api.travis-ci.org'
+
+        attr_reader :repository_name
+
+        def initialize(repository_name)
+          self.class.headers 'Accept' => 'application/json; version=2'
+
+          @repository_name = repository_name
+        end
+
+        def passed?(branch)
+          state(branch) == "passed"
+        end
+
+        def state(branch)
+          branch(branch)["state"]
+        end
+
+        private
+
+        def repository
+          @repository ||= get("/repos/#{@repository_name}")["repo"]
+        end
+
+        def branch(branch_name)
+          @branches ||= {}
+          @branches[branch_name] ||= get("/repos/#{repository["id"]}/branches/#{branch_name}")["branch"]
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ci/clients/travis_pro.rb

@@ -0,0 +1,15 @@
+module Capistrano
+  module CI
+    module Clients
+      class TravisPro < Travis
+        base_uri 'https://api.travis-ci.com'
+
+        def initialize(repository_name, api_token)
+          @repository_name = repository_name
+
+          self.class.headers 'Accept' => 'application/json; version=2', "Authorization" => "token #{api_token}"
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/ci/recipes.rb

@@ -0,0 +1,19 @@
+require 'capistrano/ci'
+
+Capistrano::Configuration.instance(true).load do
+  namespace :ci do
+    desc "verification of branch build status on CI"
+    task :verify do
+      begin
+        client = Capistrano::CI::Client.new self
+
+        unless client.passed?(branch)
+          Capistrano::CLI.ui.say "Your '#{branch}' branch has '#{client.state(branch)}' state on CI."
+          Capistrano::CLI.ui.ask("Continue anyway? (y/N)") == 'y' or abort
+        end
+      rescue => e
+        Capistrano::CLI.ui.say "#{e.class.name}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/capistrano/ci/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Ci
+    VERSION = "0.0.1"
+  end
+end

data/lib/capistrano/ci.rb

@@ -0,0 +1,5 @@
+require "capistrano/ci/version"
+require "capistrano/ci/clients/base"
+require "capistrano/ci/clients/travis"
+require "capistrano/ci/clients/travis_pro"
+require "capistrano/ci/client"

data/spec/capistrano/ci/client_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+class CIConfig < Hash
+  alias_method :exists?, :key?
+end
+
+describe Capistrano::CI::Client do
+  let(:config) do
+    config = CIConfig.new
+    config[:ci_client] = ci_client
+    config[:ci_repository] = "rails/rails"
+    config[:ci_access_token] = "token"
+    config
+  end
+
+  let(:client){ described_class.new(config) }
+
+  describe "#state" do
+
+    subject{ client.state("master") }
+
+    context "when travis" do
+      let(:ci_client){ "travis" }
+      let(:travis_client){ double(state: "passed") }
+
+     before do
+        Capistrano::CI::Clients::Travis.should_receive(:new).with("rails/rails").and_return(travis_client)
+      end
+
+      it{ should == "passed" }
+    end
+
+    context "when travis pro" do
+      let(:ci_client){ "travis_pro" }
+      let(:travis_client){ double(state: "passed") }
+
+     before do
+        Capistrano::CI::Clients::TravisPro.should_receive(:new).with("rails/rails","token").and_return(travis_client)
+      end
+
+      it{ should == "passed" }
+    end
+
+    context "when unsupported" do
+      let(:ci_client){ "unsupported" }
+
+      it{ expect{ subject }.to raise_error(Capistrano::CI::Client::NotFound) }
+    end
+  end
+
+  describe "#passed?" do
+    subject{ client.passed?("master") }
+
+    context "when travis" do
+      let(:ci_client){ "travis" }
+      let(:travis_client){ double(passed?: true) }
+
+      before do
+        Capistrano::CI::Clients::Travis.should_receive(:new).with("rails/rails").and_return(travis_client)
+      end
+
+      it{ should == true }
+    end
+
+    context "when travis pro" do
+      let(:ci_client){ "travis_pro" }
+      let(:travis_client){ double(passed?: true) }
+
+      before do
+        Capistrano::CI::Clients::Travis.should_receive(:new).with("rails/rails","token").and_return(travis_client)
+      end
+
+      it{ should == true }
+    end
+    context "when unsupported" do
+      let(:ci_client){ "unsupported" }
+
+      it{ expect{ subject }.to raise_error(Capistrano::CI::Client::NotFound) }
+    end
+  end
+end

data/spec/capistrano/ci/clients/base_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Capistrano::CI::Clients::Base do
+  describe "#passed?" do
+    subject{ described_class.new.passed?("master") }
+
+    it{ ->{ subject }.should raise_error(NotImplementedError) }
+  end
+
+  describe "#state" do
+    subject{ described_class.new.state("master") }
+
+    it{ ->{ subject }.should raise_error(NotImplementedError) }
+  end
+end

data/spec/capistrano/ci/clients/travis_pro_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Capistrano::CI::Clients::TravisPro, :vcr do
+  let(:client){ described_class.new("rails/rails-private", "secret_token") }
+
+  describe "#passed?" do
+    subject{ client.passed?(branch_name) }
+
+    context "when passed" do
+      let(:branch_name){ "master" }
+
+      it{ should == true }
+    end
+
+    context "when not passed" do
+      let(:branch_name){ "events-framework" }
+
+      it{ should == false }
+    end
+  end
+
+  describe "#state" do
+
+    subject{ client.state(branch_name) }
+
+    context "when passed" do
+      let(:branch_name){ "master" }
+
+      it{ should == "passed" }
+    end
+
+    context "when not passed" do
+      let(:branch_name){ "events-framework" }
+
+      it{ should == "started" }
+    end
+
+    context "when repository was not found" do
+      let(:client){ described_class.new("rails/some_strange_repo", "secret_token") }
+
+      let(:branch_name){ "master" }
+
+      it{ expect{ subject }.to raise_error(Capistrano::CI::Clients::ResponseError) }
+    end
+  end
+end

data/spec/capistrano/ci/clients/travis_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Capistrano::CI::Clients::Travis, :vcr do
+  describe "#passed?" do
+    subject{ client.passed?("master") }
+
+    context "when passed" do
+      let(:client){ described_class.new("rails/rails") }
+
+      it{ should == true }
+    end
+
+    context "when failed" do
+      let(:client){ described_class.new("railsware/zero_deploy") }
+
+      it{ should == false }
+    end
+  end
+
+  describe "#state" do
+
+    subject{ client.state("master") }
+
+
+    context "when passed" do
+      let(:client){ described_class.new("rails/rails") }
+
+      it{ should == "passed" }
+    end
+
+    context "when failed" do
+      let(:client){ described_class.new("railsware/zero_deploy") }
+
+      it{ should == "failed" }
+    end
+
+    context "when repository was not found" do
+      let(:client){ described_class.new("rails/some_strange_repo") }
+
+      it{ expect{ subject }.to raise_error(Capistrano::CI::Clients::ResponseError) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+require 'vcr'
+
+SimpleCov.start do
+  add_filter '/spec/'
+
+  add_group 'Libraries', '/lib/'
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = "spec/vcr"
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.ignore_localhost = true
+end
+
+RSpec.configure do |config|
+  require "capistrano/ci"
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

data/spec/vcr/Capistrano_CI_Clients_Travis/_passed_/when_failed/.yml

@@ -0,0 +1,122 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.travis-ci.org/repos/railsware/zero_deploy
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; version=2
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Expose-Headers:
+      - Content-Type, Cache-Control, Expires, Etag, Last-Modified
+      Age:
+      - '0'
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sat, 19 Oct 2013 08:57:28 GMT
+      Etag:
+      - ! '"239eb3427e8c413b25e58cba9ffe5b3d"'
+      Server:
+      - nginx/1.5.2
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept,Accept-Encoding
+      X-Accepted-Oauth-Scopes:
+      - public
+      X-Content-Digest:
+      - 1683464301ae074e6fed5351396dda29178dc27f
+      X-Endpoint:
+      - Travis::Api::App::Endpoint::Repos
+      X-Oauth-Scopes:
+      - public
+      X-Pattern:
+      - /:owner_name/:name
+      X-Rack-Cache:
+      - miss, store
+      Content-Length:
+      - '318'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"repo":{"id":544757,"slug":"railsware/zero_deploy","description":"","last_build_id":5983202,"last_build_number":"2","last_build_state":"failed","last_build_duration":31,"last_build_language":null,"last_build_started_at":"2013-04-02T11:13:13Z","last_build_finished_at":"2013-04-02T11:13:30Z","github_language":"Ruby"}}'
+    http_version: 
+  recorded_at: Sat, 19 Oct 2013 08:57:33 GMT
+- request:
+    method: get
+    uri: https://api.travis-ci.org/repos/544757/branches/master
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; version=2
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Access-Control-Expose-Headers:
+      - Content-Type, Cache-Control, Expires, Etag, Last-Modified
+      Age:
+      - '0'
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json;charset=utf-8
+      Date:
+      - Sat, 19 Oct 2013 08:57:29 GMT
+      Etag:
+      - ! '"8112a97fe15ce9bfbe1191c9368b5ae1"'
+      Server:
+      - nginx/1.5.2
+      Status:
+      - 200 OK
+      Strict-Transport-Security:
+      - max-age=31536000
+      Vary:
+      - Accept,Accept-Encoding
+      X-Accepted-Oauth-Scopes:
+      - public
+      X-Content-Digest:
+      - 9899e89a9ea15351cbc404d88f816de9910373b0
+      X-Endpoint:
+      - Travis::Api::App::Endpoint::Repos
+      X-Oauth-Scopes:
+      - public
+      X-Pattern:
+      - /:repository_id/branches/:branch
+      X-Rack-Cache:
+      - miss, store
+      Content-Length:
+      - '700'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"branch":{"id":5983202,"repository_id":544757,"commit_id":1766529,"number":"2","config":{"language":"ruby","rvm":["1.9.3","2.0.0"],".result":"configured"},"state":"failed","started_at":"2013-04-02T11:13:13Z","finished_at":"2013-04-02T11:13:30Z","duration":31,"job_ids":[5983203,5983204],"pull_request":false},"commit":{"id":1766529,"sha":"ef87117a529b2e20a34d9ddbdee82c6baf906abd","branch":"master","message":"CI
+        status added","committed_at":"2013-04-02T11:10:49Z","author_name":"gregolsen","author_email":"anotheroneman@yahoo.com","committer_name":"gregolsen","committer_email":"anotheroneman@yahoo.com","compare_url":"https://github.com/railsware/zero_deploy/compare/0a2aaa3d7050...ef87117a529b"}}'
+    http_version: 
+  recorded_at: Sat, 19 Oct 2013 08:57:33 GMT
+recorded_with: VCR 2.6.0