dolphin 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64b7b1836dabf66d97b69fe469e1f8f4033f79e1
-  data.tar.gz: 83df23c962252ad8e9410219d8a8a69fb0be9229
+  metadata.gz: f57b22721a91a02e69fcd6d356ece041a59215cc
+  data.tar.gz: 68fa17486f27058ec05277c34dd814f12e242ef1
 SHA512:
-  metadata.gz: 1cbff0b4fe5d73c500a6b99b7ef944083407fef7c4670c3d9adc9b24b369aa6a7087223d313a941ebc56fce142071bf5a6c0bebecbed1e2310480b0e8ce255c5
-  data.tar.gz: 7fb173b1c59804e27891accfba0a29e25f4485afaad496b669abaf7080ac54f50d3215013651bd1e97be282623ceb33730e9499c38e3b83d3f28406d30aed0fb
+  metadata.gz: 4f93b35088ea62118f1c33fa44f2c5f8fca4ba43de04e90f1f4b4717685b891f937c09a731d1581605cf6ad60c1c2adc7e949e40ce2132c22cfd0d4153fa2506
+  data.tar.gz: e70d4ffcf6d3ab66d9d79d36d0a4fbf4258591d5a347caef49f723b132e20e470831c05b5d9c7fd7a6270155b4413aed46b0df8a1cf4ba92f18dfee1226d66f6

data/README.md

@@ -16,9 +16,78 @@ Or install it yourself as:
 
     $ gem install dolphin
 
+## Rails generator
+
+Run generator from your Rails application:
+
+    $ bin/rails g dolphin:install
+
+This will create an executable script as bin/dolphin.
+
+## Configuration
+
+Edit the bin/dolphin script generated as above to adjust settings. Please refer to detailed comments inside the script. Minimum config would require the following:
+
+    # settings require user input
+    # -----------------------------
+    # name of this application
+    @application = 'best_app'
+    # on server, the user account for deploying
+    @user = 'deploy'
+    # location of git repository
+    @github = "git@github.com:nengxu/dolphin.git"
+    # which ruby, for chruby
+    @ruby_version = 'ruby-2.0.0-p195'
+
+    case @env
+    when 'qa'
+      @servers = [
+        'qa01.best_app.com',
+        'qa02.best_app.com',
+      ]
+    when 'production'
+      @servers = [
+        'prod01.best_app.com',
+        'prod02.best_app.com',
+      ]
+    else # @env == 'alpha'
+      # list of servers for this environment
+      @servers = [
+        'dev01.best_app.com',
+        'dev02.best_app.com',
+      ]
+      # customized branch, default is the same as @env
+      @branch = 'master'
+    end
+
 ## Usage
 
-TODO: Write usage instructions here
+Show top level command modules:
+
+    $ bin/dolphin
+
+Show subcommands under one module:
+
+    $ bin/dolphin deploy
+    $ bin/dolphin git
+    $ bin/dolphin lock
+    $ bin/dolphin nginx
+    $ bin/dolphin puma
+    $ bin/dolphin setup
+
+Execute a subcommand, for example, normal deployment:
+
+    $ bin/dolphin deploy go -e production
+
+## Related gems
+
+* [capistrano]
+* [chruby]
+* [git-deploy]
+* [hell]
+* [mina]
+* [moonshine]
+* [strano]
 
 ## Contributing
 
@@ -27,3 +96,11 @@ TODO: Write usage instructions here
 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
+
+[capistrano]: https://github.com/capistrano/capistrano
+[chruby]: https://github.com/postmodern/chruby
+[git-deploy]: https://github.com/mislav/git-deploy
+[hell]: https://github.com/seatgeek/hell
+[mina]: https://github.com/nadarei/mina
+[moonshine]: https://github.com/railsmachine/moonshine
+[strano]: https://github.com/joelmoss/strano

data/dolphin.gemspec

@@ -6,11 +6,11 @@ require 'dolphin/version'
 Gem::Specification.new do |spec|
   spec.name          = "dolphin"
   spec.version       = Dolphin::VERSION
-  spec.authors       = ["Neng Xu\n"]
+  spec.authors       = ["Neng Xu"]
   spec.email         = ["neng2.xu2@gmail.com"]
   spec.description   = %q{Dolphin: deploy smartly}
   spec.summary       = %q{Dolphin: deploy smartly}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/nengxu/dolphin"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/dolphin/lock.rb

@@ -15,8 +15,7 @@ class Dolphin::Lock < Dolphin::Base
 
   desc "create", "Create lock"
   def create
-    lock_message = "Deploy started at #{@deploy_date} in progress\n"
-    command = "echo '#{lock_message}' > #{@lock_file}"
+    command = "echo '#{@lock_message}' > #{@lock_file}"
     puts capture(command, @lead_server)
   end
 

data/lib/dolphin/version.rb

@@ -1,3 +1,3 @@
 module Dolphin
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/generators/dolphin/install_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+class Dolphin::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  def setup
+    target = "bin/dolphin"
+    copy_file "dolphin", target
+    # make it executable
+    chmod(target, 0755)
+    puts "Now edit bin/dolphin to adjust deployment settings\nThen run bin/dolphin to deploy."
+  end
+
+end

data/lib/generators/dolphin/templates/dolphin

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+require "dolphin"
+
+class Dolphin::Base
+
+  private
+
+  # deployment environments
+  def env
+    # ===================================
+    # common options for all environments
+    # ===================================
+
+    # settings require user input
+    # -----------------------------
+    # name of this application
+    @application = 'best_app'
+    # on server, the user account for deploying
+    @user = 'deploy'
+    # location of git repository
+    @github = "git@github.com:nengxu/dolphin.git"
+    # which ruby, for chruby
+    @ruby_version = 'ruby-2.0.0-p195'
+
+    # settings with default values
+    # -----------------------------
+    # on servers, the directory where Rails applications reside
+    @app_dir = '/rails'
+    # on servers under @app_dir, the directory where this application resides
+    @deploy_dir = "#{@app_dir}/#{@application}"
+    # puma related settings
+    @sockets = "#{@deploy_dir}/tmp/sockets"
+    @pids = "#{@deploy_dir}/tmp/pids"
+
+    # internal variables, no need to change by user
+    # -----------------------------
+    # ssh sessions
+    @sessions = {}
+
+    # ===================================
+    # environment specific options
+    # ===================================
+
+    # when deploy, need to specify the environment by using "-e env_name"
+    # for example: bin/dolphin deploy go -e alpha
+
+    # @env is the environment as specified
+    # @branch is the git branch for this environment
+    # by default @branch is the same as @env
+    @env = @branch =options[:env]
+
+    case @env
+    when 'qa'
+      @servers = [
+        'qa01.best_app.com',
+        'qa02.best_app.com',
+      ]
+    when 'production'
+      @servers = [
+        'prod01.best_app.com',
+        'prod02.best_app.com',
+      ]
+    else # @env == 'alpha'
+      # list of servers for this environment
+      @servers = [
+        'dev01.best_app.com',
+        'dev02.best_app.com',
+      ]
+      # customized branch, default is the same as @env
+      @branch = 'master'
+    end
+
+    # ===================================
+    # settings to avoid simultaneous deployments
+    # ===================================
+
+    # current deployment will abort when another deployment is still in progress
+
+    # lead server for lock status
+    @lead_server = @servers[0]
+    # name and location of the lock file
+    @lock_file = "#{@deploy_dir}/tmp/pids/dolphin.lock"
+    # format of date/time for lock file
+    @deploy_date = Time.now.strftime("%m%d%H%M")
+    # custom content for the lock file
+    @lock_message = "Deploy started at #{@deploy_date} in progress\n"
+
+  end
+end
+
+# start the CLI
+Dolphin::CLI.start

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dolphin
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
-- |
-  Neng Xu
+- Neng Xu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-13 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -99,7 +98,9 @@ files:
 - lib/dolphin/deploy.rb
 - lib/dolphin/lock.rb
 - lib/dolphin/version.rb
-homepage: ''
+- lib/generators/dolphin/install_generator.rb
+- lib/generators/dolphin/templates/dolphin
+homepage: https://github.com/nengxu/dolphin
 licenses:
 - MIT
 metadata: {}