capistrano-4ever 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbfabf38a9606124f34ab303cab1bcba79717a1e
+  data.tar.gz: 26013e81c790a4c480fa3afe32cc2ebdb9a888a1
+SHA512:
+  metadata.gz: 3156a91e659dce79bc053960f697a4d3beef706d26af6b731a88804e6963a7880d6dce55cff9cfd902d124989502f5786ac3ad411353a8b86e385e4f7910bfe0
+  data.tar.gz: 1ea1f880c19b02746742a79d0d5dad65dda6ce13790f798b86a523977aa0c8cd1ddd02abb7b989df09365c242bd23a704961aa658db84720be4a1ce91c7f1a1c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Forrest Fleming
+
+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,90 @@
+# capistrano-4ever
+
+This gem provides some Capistrano3 tasks for deploying NodeJS servers using the
+npm package Forever to make sure that that application runs forever.
+The gem is named 'capistrano-4ever', as 'capistrano-forever' was taken (thus,
+perhaps, rendering this gem redundant).  In any case, this gem namespaces under
+'forever' instead of '4ever', and so the two gems are incompatible.
+
+[Available via RubyGems](https://rubygems.org/gems/capistrano-4ever)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-4ever'
+```
+
+And then execute:
+
+    % bundle
+
+Or install it yourself as:
+
+    % gem install capistrano-4ever
+
+## Usage
+
+Require in Capfile:
+```ruby
+require 'capistrano/forever'
+```
+
+### Configuration options to be set in deploy.rb
+`:forever_env_variables` : Any environmental variables you'd like, as a hash.  I recommend setting `NODE_ENV` here.<br>
+`:forever_path` : Path to globally installed forever binary.<br>
+`:forever_app` : The application you're deploying.<br>
+`:forever_target_path` : The target path.  Defaults to Capistrano's `release_path`.  I recommend that you don't set this.<br>
+`:forever_flags` : Flags to pass to the forever binary as a string.
+  * NB: **Order is important** here!  Ape the order in the example below or play around, but don't be frustrated if something that seems like it should work doesn't.  This is due to how the foreman binary parses options.
+
+### Configuration defaults
+Configuration symbol | Default
+---------------|-----------------
+`:forever_env_variables` | `{}`<br>
+`:forever_path` | `'forever'` (let `env` take care of pathing)
+`:forever_app` | `'main.js'`<br>
+`:forever_target_path` | Capistrano's `release_path`<br>
+`:forever_flags` | `'--append --uid <forever_app>'`
+
+### Configuration recommendations
+I recommend setting:<br>
+  `-l` : So that you can have a shared logfile across deploys<br>
+  `--append` : Append to logfiles and don't die when the logfile exists<br>
+  `--minUptime` : If nothing else, keep NodeJS from complaing that you didn't set it.<br>
+  `--spinSleepTime` : See above<br>
+  `--uid <string>` : Set a custom string so that this gem will be able to stop previously-started instances.<br>
+  
+### Example
+```ruby
+set :forever_env_variables, {'NODE_ENV' => "#{fetch(:npm_env)}"}
+set :forever_path, '/usr/bin/forever'
+set :forever_app, 'dog-sitting-calendar.js'
+set :forever_target_path, '/var/www/dogsit'
+set :forever_flags, [ "-l #{fetch :forever_target_path}/log/forever.log",
+                      '--append',
+                      '--minUptime 1000',
+                      '--spinSleepTime 1000',
+                      "--uid '#{fetch :forever_app}'" ].join(' ')
+```
+
+### Custom tasks
+```
+% bundle exec cap <environment> forever:<task>
+```
+* `check` : Check for `forever` binary on deploy target
+  * Displays human-readable output; not for scripting
+* `start` : Start NodeJS server with forever
+* `stop`: Stop NodeJS server with forever
+* `restart` : Restart NodeJS server with forever
+* `stop_all` : Stop all NodeJS servers managed by forever on target server
+* `restart_all` : Restart all NodeJS servers managed by forever on target server
+
+## Contributing
+
+1. Fork it ( https://github.com/oversee-ffleming/capistrano-forever/fork )
+2. Create your feature branch (`git checkout -b new-feature`)
+3. Commit your changes (`git commit -am 'Added a neat feature!'`)
+4. Push to the branch (`git push origin new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/capistrano-4ever.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/forever/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-4ever"
+  spec.version       = Capistrano::Forever::VERSION
+  spec.authors       = ["Forrest Fleming"]
+  spec.email         = ["ffleming@oversee.net"]
+  spec.summary       = 'Capistrano3 tasks for deploying NodeJS servers via forever'
+  spec.description   = 'Provides forever: namespace with several tasks for deploying NodeJS server via forever'
+  spec.homepage      = "https://github.com/oversee-ffleming/capistrano-forever"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/forever.rb

@@ -0,0 +1,7 @@
+load File.expand_path('../tasks/forever.rake', __FILE__)
+require "capistrano/forever/version"
+
+module Capistrano
+  module Forever
+  end
+end

data/lib/capistrano/forever/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Forever
+    VERSION = "0.2.0"
+  end
+end

data/lib/capistrano/tasks/forever.rake

@@ -0,0 +1,89 @@
+namespace :forever do
+  def default_forever_path
+    'forever'
+  end
+
+  def default_forever_app
+    'main.js'
+  end
+
+  def default_forever_flags
+    "-a --uid cap-forever-#{fetch(:forever_app, default_forever_app)}"
+  end
+
+  def default_target_path
+    release_path
+  end
+
+  desc 'Checks to see that forever is installed globally on the target machines'
+  task :check do
+    on roles :app do
+      exists = test("[ -f #{fetch(:forever_path, default_forever_path)} ]")
+      forever_check = "Forever is not installed to #{fetch(:forever_path, default_forever_path)}"
+      if exists
+        can_execute = test("[ -x #{fetch(:forever_path, default_forever_path)} ]")
+        forever_check = "Forever is installed to #{fetch(:forever_path, default_forever_path)}"
+        forever_check <<  " #{can_execute ? 'and is' : 'but isn\'t'} executable by #{fetch :user}"
+      end
+      puts forever_check
+    end
+  end
+
+  desc 'Starts the server process via forever'
+  task :start do
+    on roles :app do
+      within fetch(:forever_target_path, default_target_path) do
+        with fetch(:forever_env_variables, {}) do
+          execute fetch(:forever_path, default_forever_path), fetch(:forever_flags, default_forever_flags), 'start', fetch(:forever_app, default_forever_app)
+        end
+      end
+    end
+  end
+
+  desc 'Stops the server process via forever'
+  task :stop do
+    on roles :app do
+      within fetch(:forever_target_path, default_target_path) do
+        with fetch(:forever_env_variables, {}) do
+          begin
+            execute fetch(:forever_path, default_forever_path), fetch(:forever_flags, default_forever_flags), 'stop', fetch(:forever_app, default_forever_app)
+          rescue => e
+            raise e unless e.to_s.include? 'cannot find process with id'
+            puts "Forever: Couldn't stop #{fetch(:forever_app, default_forever_app)} - process not found"
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Restarts the server process via forever'
+  task :restart do
+    on roles :app do
+      invoke 'forever:stop'
+      invoke 'forever:start'
+    end
+  end
+
+  desc 'Stops all server processes managed by forever'
+  task :stop_all do
+    on roles :app do
+      within fetch(:forever_target_path, default_target_path) do
+        with fetch(:forever_env_variables, {}) do
+          execute fetch(:forever_path, default_forever_path), 'stopall'
+        end
+      end
+    end
+  end
+
+  desc 'Restarts all server processes managed by forever'
+  task :restart_all do
+    on roles :app do
+      within fetch(:forever_target_path, default_target_path) do
+        with fetch(:forever_env_variables, {}) do
+          execute fetch(:forever_path, default_forever_path), 'restartall'
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-4ever
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Forrest Fleming
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 'Provides forever: namespace with several tasks for deploying NodeJS
+  server via forever'
+email:
+- ffleming@oversee.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-4ever.gemspec
+- lib/capistrano-forever.rb
+- lib/capistrano/forever.rb
+- lib/capistrano/forever/version.rb
+- lib/capistrano/tasks/forever.rake
+homepage: https://github.com/oversee-ffleming/capistrano-forever
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Capistrano3 tasks for deploying NodeJS servers via forever
+test_files: []