capistrano-hivequeen 0.9.1 → 1.0.0

data/capistrano-hivequeen.gemspec

@@ -1,3 +1,5 @@
+require File.expand_path('./lib/capistrano/hivequeen/version.rb')
+
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
@@ -6,7 +8,7 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'capistrano-hivequeen'
-  s.version           = '0.9.1'
+  s.version           = HiveQueen::Version.to_s
   s.date              = Time.now.strftime("%Y-%m-%d")
 
   ## Make sure your summary is short. The description may be as long
@@ -35,8 +37,8 @@ Gem::Specification.new do |s|
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
-  s.add_dependency('capistrano-ext')
-  s.add_dependency('capistrano')
+  s.add_dependency('capistrano-ext', '= 1.2.1')
+  s.add_dependency('capistrano', '~> 2.11.2')
   s.add_dependency('json')
   s.add_dependency('excon', '>= 0.6.0') # Perhaps we can support older. Haven't checked.
 

data/lib/capistrano/hivequeen.rb

@@ -1,80 +1,123 @@
-# Load environment configuration from HiveQueen
-require "capistrano/hivequeen/server"
-
-Capistrano::Configuration.instance(:must_exist).load do
-  HiveQueen.endpoint = hivequeen_endpoint
-  HiveQueen.project = application
-  HiveQueen.logger = logger
-  HiveQueen.get_credentials!
-
-  # Redefine stage tasks from multistage extension
-  # Set the list of available stages
-  set :stages, HiveQueen.environment_names
-
-  # Default to using the current branch as the stage name
-  # NB: current branch may not be set
-  current_branch = `git symbolic-ref HEAD`.chomp.sub('refs/heads/', '')
-  unless current_branch.empty?
-    env_name = HiveQueen.environment_for_branch(current_branch)
-    set(:default_stage, env_name) if env_name
-  end
+# HTTP Client for Hive Queen environment configuration
+require 'json'
+require 'fileutils'
+require 'excon'
+require 'base64'
+require 'capistrano/hivequeen/version'
 
-  set :repository, HiveQueen.repository
-  set :scm, :git
-  ssh_options[:forward_agent] = true
-
-  # By default, don't override deployments if there's another deployment in progress.
-  # From the command line, use -s override=true to force a deployment
-  set :override, false
-
-  # Time to wait for Background jobs processes to start/stop
-  set :bg_wait_time, 30
-
-  # Option to skip background tasks
-  set :skip_bg, false
-
-  # Load capistrano multi-stage extension
-  require 'fileutils' # required until https://github.com/capistrano/capistrano-ext/commit/930ca840a0b4adad0ec53546790b3f5ffe726538 is released
-  require 'capistrano/ext/multistage'
-  require 'capistrano/hivequeen/setup'
-  require 'capistrano/hivequeen/deploy'
-
-  # Redefine stage tasks from multistage extension
-  HiveQueen.environments.each do |env|
-    name = env['name']
-    hive_queen_id = env['id']
-
-    desc "Use environment #{name}"
-    task name do
-      environment = HiveQueen.roles(hive_queen_id)
-      # Check if environment is ready
-      unless environment['state'] == 'running'
-        abort "Environment #{name} is not ready. State: #{environment['state']}"
-      end
+# Special cases:
+# - environment not found
+# - environment not ready: fail
+class HiveQueen
+  class DeploymentError < Exception; end
+  class InsecureCredentials < Exception; end
 
-      set :stage, name.to_sym
-      set :rails_env, name
-      set :environment_id, hive_queen_id
-      unless exists?(:branch)
-        set :branch, environment['branch']
-      end
+  class << self
+    attr_accessor :endpoint, :logger, :project, :username, :password
+
+    def project_data
+      @project_data ||= get("/projects/#{project}.json")
+    end
+
+    def environments
+      project_data['environments']
+    end
+
+    def environment_names
+      environments.map{|e| e['name'].to_sym }
+    end
+
+    def environment_for_branch(branch)
+      env = environments.detect{|e| e['branch'] == branch }
+      env['name'] if env
+    end
+
+    def repository
+      project_data['repo']
+    end
+
+    def roles(env_id)
+      env_id = env_id.to_sym
+      @roles ||= {}
+      @roles[env_id] ||= get("/environments/#{env_id}.json")
+    end
 
-      # Set servers for each role
-      environment['roles'].each do |role_name, role_config|
-        role(role_name.to_sym) { role_config['servers'] }
+    def start_deployment(environment_id, params)
+      required_params = [:task, :commit]
+      required_params.each do |key|
+        raise ArgumentError.new("#{key} is a required param") unless params.key?(key)
       end
+      put_or_post('POST', "/environments/#{environment_id}/deployments.json", :deployment => params)
+    end
+
+    def finish_deployment(environment_id, deployment_id)
+      state = $! ? 'failed' : 'succeeded'
+      puts "Finishing deployment in Hivequeen. State: #{state}"
+      params = {:deployment => {:state => state}}
+      put_or_post('PUT', "/environments/#{environment_id}/deployments/#{deployment_id}.json", params)
+    end
+
+    # Load credentials from ~/.hivequeen
+    def get_credentials!
+      @username, @password = File.read(credential_path).chomp.split(':')
+      raise unless username && password
+      # Check that credentials are not accessible to world or group
+      mode = File.stat(credential_path).mode
+      raise InsecureCredentials unless (mode % 64 == 0)
+    rescue InsecureCredentials
+      puts "#{credential_path} is insecure. Please change you password and run"
+      puts "chmod 600 #{credential_path}"
+      exit 1
+    rescue Errno::ENOENT, RuntimeError
+      puts "Could not read HiveQueen credentials from #{credential_path}."
+      puts "#{credential_path} should contain your username and password seperated by a colon"
+      puts "Run this command with your credentials:"
+      puts " $ echo username:password > #{credential_path}; chmod 600 #{credential_path}"
+      exit 1
+    end
+
+    protected
+    def credential_path
+      File.join(ENV['HOME'], '.hivequeen')
+    end
 
-      # Ensure some server designated as db server
-      unless roles.key?(:db)
-        # Prefer the bg server
-        db_server = roles[:bg].servers.first if roles.key?(:bg)
+    def connection
+      Excon.new(endpoint)
+    end
 
-        # Otherwise, use any server
-        db_server ||= roles.values.map{|x| x.servers}.flatten.compact.first
-        logger.trace "Using #{db_server} as primary db server"
-        role :db, db_server.to_s, :primary => true
+    def auth_header
+      value = Base64.encode64([username, password] * ':').chomp
+      { 'Authorization' => "Basic #{value}" }
+    end
+
+    def get(path)
+      url = "#{endpoint}#{path}"
+      logger.trace "Fetching #{url}"
+      response = connection.request(:method => 'GET', :path => path, :headers => auth_header)
+      unless (200..299).include?(response.status)
+        raise "Request to #{url} returned #{response.status} status"
       end
+      JSON.parse(response.body)
+    end
 
+    def put_or_post(method, path, data)
+      headers = auth_header.merge("Content-type"=>"application/json", "Accept"=>"application/json")
+      response = connection.request(:path => path, :method => method, :headers => headers, :body => data.to_json)
+      case response.status
+      when 204
+        # Do nothing
+      when (200..299)
+        JSON.parse(response.body)
+      when (400..499)
+        errors = JSON.parse(response.body)
+        raise DeploymentError.new(errors.inspect)
+      else
+        raise "Request to #{path} returned #{response.status} status"
+      end
     end
+
   end
 end
+
+require "capistrano/hivequeen/capistrano_configuration"
+

data/lib/capistrano/hivequeen/capistrano_configuration.rb

@@ -0,0 +1,77 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  HiveQueen.endpoint = hivequeen_endpoint
+  HiveQueen.project = application
+  HiveQueen.logger = logger
+  HiveQueen.get_credentials!
+
+  # Redefine stage tasks from multistage extension
+  # Set the list of available stages
+  set :stages, HiveQueen.environment_names
+
+  # Default to using the current branch as the stage name
+  # NB: current branch may not be set
+  current_branch = `git symbolic-ref HEAD`.chomp.sub('refs/heads/', '')
+  unless current_branch.empty?
+    env_name = HiveQueen.environment_for_branch(current_branch)
+    set(:default_stage, env_name) if env_name
+  end
+
+  set :repository, HiveQueen.repository
+  set :scm, :git
+  ssh_options[:forward_agent] = true
+
+  # By default, don't override deployments if there's another deployment in progress.
+  # From the command line, use -s override=true to force a deployment
+  set :override, false
+
+  # Time to wait for Background jobs processes to start/stop
+  set :bg_wait_time, 30
+
+  # Option to skip background tasks
+  set :skip_bg, false
+
+  # Load capistrano multi-stage extension
+  require 'fileutils' # required until https://github.com/capistrano/capistrano-ext/commit/930ca840a0b4adad0ec53546790b3f5ffe726538 is released
+  require 'capistrano/ext/multistage'
+  require 'capistrano/hivequeen/setup'
+  require 'capistrano/hivequeen/deploy'
+
+  # Redefine stage tasks from multistage extension
+  HiveQueen.environments.each do |env|
+    name = env['name']
+    hive_queen_id = env['id']
+
+    desc "Use environment #{name}"
+    task name do
+      environment = HiveQueen.roles(hive_queen_id)
+      # Check if environment is ready
+      unless environment['state'] == 'running'
+        abort "Environment #{name} is not ready. State: #{environment['state']}"
+      end
+
+      set :stage, name.to_sym
+      set :rails_env, name
+      set :environment_id, hive_queen_id
+      unless exists?(:branch)
+        set :branch, environment['branch']
+      end
+
+      # Set servers for each role
+      environment['roles'].each do |role_name, role_config|
+        role(role_name.to_sym) { role_config['servers'] }
+      end
+
+      # Ensure some server designated as db server
+      unless roles.key?(:db)
+        # Prefer the bg server
+        db_server = roles[:bg].servers.first if roles.key?(:bg)
+
+        # Otherwise, use any server
+        db_server ||= roles.values.map{|x| x.servers}.flatten.compact.first
+        logger.trace "Using #{db_server} as primary db server"
+        role :db, db_server.to_s, :primary => true
+      end
+
+    end
+  end
+end

data/lib/capistrano/hivequeen/version.rb

@@ -0,0 +1,10 @@
+class HiveQueen
+  class Version
+    @@version = '1.0.0'
+
+    def self.to_s
+      @@version
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-hivequeen
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,33 +9,33 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000 Z
+date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano-ext
-  requirement: &70238578596280 !ruby/object:Gem::Requirement
+  requirement: &70240114614400 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - =
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70238578596280
+  version_requirements: *70240114614400
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70238578595320 !ruby/object:Gem::Requirement
+  requirement: &70240114612720 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.11.2
   type: :runtime
   prerelease: false
-  version_requirements: *70238578595320
+  version_requirements: *70240114612720
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70238578594620 !ruby/object:Gem::Requirement
+  requirement: &70240114611740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70238578594620
+  version_requirements: *70240114611740
 - !ruby/object:Gem::Dependency
   name: excon
-  requirement: &70238578593960 !ruby/object:Gem::Requirement
+  requirement: &70240114610620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70238578593960
+  version_requirements: *70240114610620
 description: Capistrano extensions for interacting with HiveQueen
 email: aaron@kickstarter.com
 executables: []
@@ -66,9 +66,10 @@ files:
 - README.rdoc
 - capistrano-hivequeen.gemspec
 - lib/capistrano/hivequeen.rb
+- lib/capistrano/hivequeen/capistrano_configuration.rb
 - lib/capistrano/hivequeen/deploy.rb
-- lib/capistrano/hivequeen/server.rb
 - lib/capistrano/hivequeen/setup.rb
+- lib/capistrano/hivequeen/version.rb
 homepage: http://github.com/kickstarter/capistrano-hivequeen
 licenses: []
 post_install_message: 

data/lib/capistrano/hivequeen/server.rb

@@ -1,117 +0,0 @@
-# HTTP Client for Hive Queen environment configuration
-require 'json'
-require 'fileutils'
-require 'excon'
-require 'base64'
-
-# Special cases:
-# - environment not found
-# - environment not ready: fail
-class HiveQueen
-  class DeploymentError < Exception; end
-  class InsecureCredentials < Exception; end
-
-  class << self
-    attr_accessor :endpoint, :logger, :project, :username, :password
-
-    def project_data
-      @project_data ||= get("/projects/#{project}.json")
-    end
-
-    def environments
-      project_data['environments']
-    end
-
-    def environment_names
-      environments.map{|e| e['name'].to_sym }
-    end
-
-    def environment_for_branch(branch)
-      env = environments.detect{|e| e['branch'] == branch }
-      env['name'] if env
-    end
-
-    def repository
-      project_data['repo']
-    end
-
-    def roles(env_id)
-      env_id = env_id.to_sym
-      @roles ||= {}
-      @roles[env_id] ||= get("/environments/#{env_id}.json")
-    end
-
-    def start_deployment(environment_id, params)
-      required_params = [:task, :commit]
-      required_params.each do |key|
-        raise ArgumentError.new("#{key} is a required param") unless params.key?(key)
-      end
-      put_or_post('POST', "/environments/#{environment_id}/deployments.json", :deployment => params)
-    end
-
-    def finish_deployment(environment_id, deployment_id)
-      state = $! ? 'failed' : 'succeeded'
-      puts "Finishing deployment in Hivequeen. State: #{state}"
-      params = {:deployment => {:state => state}}
-      put_or_post('PUT', "/environments/#{environment_id}/deployments/#{deployment_id}.json", params)
-    end
-
-    # Load credentials from ~/.hivequeen
-    def get_credentials!
-      @username, @password = File.read(credential_path).chomp.split(':')
-      raise unless username && password
-      # Check that credentials are not accessible to world or group
-      mode = File.stat(credential_path).mode
-      raise InsecureCredentials unless (mode % 64 == 0)
-    rescue InsecureCredentials
-      puts "#{credential_path} is insecure. Please change you password and run"
-      puts "chmod 600 #{credential_path}"
-      exit 1
-    rescue Errno::ENOENT, RuntimeError
-      puts "Could not read HiveQueen credentials from #{credential_path}."
-      puts "#{credential_path} should contain your username and password seperated by a colon"
-      puts "Run this command with your credentials:"
-      puts " $ echo username:password > #{credential_path}; chmod 600 #{credential_path}"
-      exit 1
-    end
-
-    protected
-    def credential_path
-      File.join(ENV['HOME'], '.hivequeen')
-    end
-
-    def connection
-      Excon.new(endpoint)
-    end
-
-    def auth_header
-      value = Base64.encode64([username, password] * ':').chomp
-      { 'Authorization' => "Basic #{value}" }
-    end
-
-    def get(path)
-      url = "#{endpoint}#{path}"
-      logger.trace "Fetching #{url}"
-      response = connection.request(:method => 'GET', :path => path, :headers => auth_header)
-      unless (200..299).include?(response.status)
-        raise "Request to #{url} returned #{response.status} status"
-      end
-      JSON.parse(response.body)
-    end
-
-    def put_or_post(method, path, data)
-      headers = auth_header.merge("Content-type"=>"application/json", "Accept"=>"application/json")
-      response = connection.request(:path => path, :method => method, :headers => headers, :body => data.to_json)
-      case response.status
-      when (200..299)
-        JSON.parse(response.body)
-      when (400..499)
-        errors = JSON.parse(response.body)
-        raise DeploymentError.new(errors.inspect)
-      else
-        raise "Request to #{path} returned #{response.status} status"
-      end
-    end
-
-  end
-end