capistrano-github 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5bb311c329dab6f2fd19814a5a1279c37bf8f498
+  data.tar.gz: 3ed9de0588362840fa0ef2a971da170e79420441
+SHA512:
+  metadata.gz: 72d86d54e1f12b539ed07711a23846cd34980750d247522f2847053d47cb106cd352fe59a7ea3b225b3653ca49b05f6670bf051a88db0ed9077f161ad5992e67
+  data.tar.gz: 17d0fff867af5801704e67a1bebc41e74fb0848166e02a3d5a3144ec462ced1fb0892a6eb5cfc8b9d323a6ac723b9c56c9bc71a026f6cc8bc45c6069d586d23e

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kir Shatrov
+
+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,52 @@
+# Capistrano::Github
+
+In January 2014 Github Team [announced Deployments API](http://developer.github.com/changes/2014-01-09-preview-the-new-deployments-api/) and you can use it with Capistrano 3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-github', github: '3scale/capistrano-github'
+
+And then execute:
+
+    $ bundle
+
+
+Require github tasks and set `github_access_token`:
+
+```ruby
+# Capfile
+require 'capistrano/github'
+```
+
+```ruby
+# deploy.rb
+set :github_access_token, '89c3be3d1f917b6ccf5e2c141dbc403f57bc140c'
+
+
+before 'deploy:starting', 'github:deployment:create'
+after  'deploy:starting', 'github:deployment:pending'
+after  'deploy:finished', 'github:deployment:success'
+after  'deploy:failed',   'github:deployment:failure'
+```
+
+You can get your personal GH token [here](https://github.com/settings/applications)
+
+## Usage
+
+New deployment record will be created automatically on each `cap deploy` run.
+
+To see the list of deployments, execute
+
+```bash
+cap production github:deployments
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/3scale/capistrano-github/fork )
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-github.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/github/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-github"
+  spec.version       = Capistrano::Github::VERSION
+  spec.authors       = ["Kir Shatrov", 'Michal Cichra']
+  spec.email         = ["shatrov@me.com", 'michal@3scale.net']
+  spec.summary       = %q{Integrates Capistrano with Github Deployments API}
+  spec.homepage      = "http://github.com/capistrano/github"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "capistrano", "~> 3.1"
+  spec.add_dependency "octokit", ">= 3.0", "< 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 3.1'
+end

data/lib/capistrano/github/api.rb

@@ -0,0 +1,67 @@
+require 'octokit'
+
+module Capistrano
+  module Github
+    class API
+      class Deployment
+        attr_accessor :created_at, :ref, :sha, :creator_login, :payload, :statuses, :id, :environment
+
+        class Status
+          attr_accessor :created_at, :state
+        end
+      end
+
+      REPO_FORMAT = /git@github.com:([\S]*)\/([\S]*).git/
+
+      attr_reader :client
+
+      def initialize(repo_url, token)
+        raise MissingAccessToken unless token
+        @client = Octokit::Client.new(access_token: token)
+        @repo = parse_repo_url(repo_url)
+      end
+
+      def create_deployment(branch, options = {})
+        @client.create_deployment(@repo, branch, options).id
+      end
+
+      def create_deployment_status(id, state)
+        @client.create_deployment_status(deployment_url(id), state)
+      end
+
+      def deployments(options = {})
+        @client.deployments(@repo, options).map do |d|
+          Deployment.new.tap do |dep|
+            dep.created_at = d.created_at
+            dep.sha = d.sha
+            dep.ref = d.ref
+            dep.creator_login = d.creator.login
+            dep.payload = d.payload
+            dep.id = d.id
+            dep.environment = d.environment
+
+            dep.statuses = deployment_statuses(d.id)
+          end
+        end
+      end
+
+      private
+
+      def deployment_statuses(id)
+        @client.deployment_statuses(deployment_url(id))
+      end
+
+      def deployment_url(id)
+        "repos/#{@repo}/deployments/#{id}"
+      end
+
+      def parse_repo_url(url)
+        repo_match = url && url.match(REPO_FORMAT) or raise InvalidRepoUrl, url
+        "#{repo_match[1]}/#{repo_match[2]}"
+      end
+
+      InvalidRepoUrl = Class.new(StandardError)
+      MissingAccessToken = Class.new(StandardError)
+    end
+  end
+end

data/lib/capistrano/github/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Github
+    VERSION = '0.1.0'
+  end
+end

data/lib/capistrano/github.rb

@@ -0,0 +1,10 @@
+load File.expand_path("../tasks/github.rake", __FILE__)
+
+require "capistrano/github/version"
+require "capistrano/github/api"
+
+module Capistrano
+  module Github
+    # Your code goes here...
+  end
+end

data/lib/capistrano/tasks/github.rake

@@ -0,0 +1,82 @@
+require 'capistrano/github/api'
+
+set_if_empty :github_deployment_payload, -> do
+  {
+
+  }
+end
+
+set_if_empty :github_deployment, -> do
+  {
+      auto_merge: false,
+      environment: fetch(:stage)
+  }
+end
+
+set_if_empty :github_deployment_api, -> do
+  Capistrano::Github::API.new(fetch(:repo_url), fetch(:github_access_token))
+end
+
+set :github_deployment_required, false
+
+set :github_deployment_enabled, -> do
+  begin
+    fetch(:github_deployment_api)
+  rescue Capistrano::Github::API::MissingAccessToken
+    false
+  end
+end
+
+set :github_deployment_skip, -> do
+  !fetch(:github_deployment_enabled) && !fetch(:github_deployment_required)
+end
+
+namespace :github do
+
+  namespace :deployment do
+    desc 'Create new deployment'
+    task :create do
+      next if fetch(:github_deployment_skip)
+
+      gh = fetch(:github_deployment_api)
+      payload = fetch(:github_deployment_payload)
+      config = fetch(:github_deployment).merge(payload: payload)
+      branch = fetch(:branch)
+
+      set :current_github_deployment, deployment = gh.create_deployment(branch, config)
+
+      run_locally do
+        info("Created GitHub Deployment #{deployment}")
+      end
+    end
+
+    [:pending, :success, :error, :failure].each do |status|
+      desc "Mark current deployment as #{status}"
+      task status => 'github:deployment:create' do
+        next if fetch(:github_deployment_skip)
+
+        gh = fetch(:github_deployment_api)
+        deployment = fetch(:current_github_deployment)
+
+        run_locally do
+          gh.create_deployment_status(deployment, status)
+          info("Marked GitHub Deployment #{deployment} as #{status}")
+        end
+      end
+    end
+  end
+
+  desc 'List Github deployments'
+  task :deployments do
+    gh = fetch(:github_deployment_api)
+    env = fetch(:github_deployment)[:environment]
+    gh.deployments(environment: env).each do |d|
+      statuses = d.statuses.reverse
+      puts "Deployment (#{statuses.last.state}): #{d.created_at} #{d.ref}@#{d.sha} to #{d.environment} by @#{d.creator_login} "
+
+      statuses.each do |s|
+        puts "\t#{s.created_at} state: #{s.state}"
+      end
+    end
+  end
+end

data/spec/github/api_spec.rb

@@ -0,0 +1,32 @@
+require 'capistrano/github/api'
+
+RSpec.describe Capistrano::Github::API do
+  subject(:api) { described_class.new(repo_url, access_token) }
+
+  let(:access_token) { 'some-token' }
+  let(:repo_url) { 'git@github.com:3scale/capistrano-github.git' }
+
+  context 'invalid repo url' do
+    let(:repo_url) { 'some-invalid' }
+
+    it do
+      expect{ subject }.to raise_error(Capistrano::Github::API::InvalidRepoUrl)
+    end
+  end
+
+  context 'missing repo url' do
+    let(:repo_url) { nil }
+
+    it do
+      expect{ subject }.to raise_error(Capistrano::Github::API::InvalidRepoUrl)
+    end
+  end
+
+  context 'missing access token' do
+    let(:access_token) { nil }
+
+    it do
+      expect{ subject }.to raise_error(Capistrano::Github::API::MissingAccessToken)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,95 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'support/shared_contexts/capistrano'
+require 'support/shared_contexts/rake'
+require 'sshkit'
+require 'capistrano/dsl'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/shared_contexts/capistrano.rb

@@ -0,0 +1,16 @@
+RSpec.shared_context :capistrano do
+  let(:env) { Capistrano::Configuration.env }
+
+  let(:repo_url) { 'git@github.com:capistrano/github.git' }
+  let(:branch) { 'master' }
+  let(:stage) { 'production' }
+
+  before do
+    Capistrano::Configuration.reset!
+
+    env.set :repo_url, repo_url
+    env.set :branch, branch
+    env.set :stage, stage
+  end
+end
+

data/spec/support/shared_contexts/rake.rb

@@ -0,0 +1,17 @@
+require 'rake'
+
+RSpec.shared_context :rake do
+  let(:rake)      { Rake::Application.new }
+  let(:task_name) { self.class.top_level_description }
+  let(:task_path) { "capistrano/tasks/#{task_name.split(":").first}" }
+  subject(:task)  { rake[task_name] }
+
+  def loaded_files_excluding_current_rake_file
+    $".reject {|file| file == "#{task_path}.rake" }
+  end
+
+  before do
+    Rake.application = rake
+    Rake.application.rake_require(task_path, $LOAD_PATH, loaded_files_excluding_current_rake_file)
+  end
+end

data/spec/tasks/github_spec.rb

@@ -0,0 +1,60 @@
+RSpec.describe 'github:deployment:create' do
+  include_context :capistrano
+  include_context :rake
+
+  it { is_expected.to be }
+
+  context 'invoke' do
+    subject(:invoke) { task.invoke }
+    it { is_expected.to be }
+
+    context 'with access token' do
+      let(:api) { instance_double(Capistrano::Github::API) }
+
+      before do
+        env.set :github_deployment_api, api
+      end
+
+      after { invoke }
+
+      it do
+        expect(api).to receive(:create_deployment)
+                           .with(branch, auto_merge: false, environment: stage, payload: {})
+                           .and_return('some-id')
+      end
+    end
+  end
+end
+
+[:pending, :success, :error, :failure].each do |status|
+  RSpec.describe "github:deployment:#{status}" do
+    include_context :capistrano
+    include_context :rake
+
+    it { is_expected.to be }
+    it { expect(task.prerequisites).to include('github:deployment:create') }
+
+    context 'invoke' do
+      subject(:invoke) { task.invoke }
+      it { is_expected.to be }
+
+      context 'with access token' do
+        let(:api) { instance_double(Capistrano::Github::API) }
+
+        let(:deployment) { rand(10000) }
+
+        before do
+          env.set :github_deployment_api, api
+          expect(api).to receive(:create_deployment).and_return(deployment)
+        end
+
+        after { invoke }
+
+        it do
+          expect(api).to receive(:create_deployment_status)
+                             .with(deployment, status)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-github
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kir Shatrov
+- Michal Cichra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email:
+- shatrov@me.com
+- michal@3scale.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-github.gemspec
+- lib/capistrano/github.rb
+- lib/capistrano/github/api.rb
+- lib/capistrano/github/version.rb
+- lib/capistrano/tasks/github.rake
+- spec/github/api_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_contexts/capistrano.rb
+- spec/support/shared_contexts/rake.rb
+- spec/tasks/github_spec.rb
+homepage: http://github.com/capistrano/github
+licenses:
+- MIT
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Integrates Capistrano with Github Deployments API
+test_files:
+- spec/github/api_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_contexts/capistrano.rb
+- spec/support/shared_contexts/rake.rb
+- spec/tasks/github_spec.rb
+has_rdoc: