capistrano-memcached 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Ruben Stranders
+
+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,131 @@
+# Capistrano::Memcached
+
+Capistrano tasks for automatic memcached configuration.
+
+Goals of this plugin:
+
+* automatic memcached configuration for Rails apps
+* **no manual ssh** to the server required
+
+Specifics:
+
+* generates config file on the server (default in /etc/memcached.conf)
+* generates a memcached.yml config file in shared/config for easy consumption by a RoR app
+* capistrano tasks for management, example: `memcached:restart`<br/>
+see below for all available tasks
+
+`capistrano-memcached` works only with Capistrano 3!
+
+This project was heavily inspired (i.e. copied and reworked) by 
+[capistrano-nginx-unicorn](https://github.com/bruno-/capistrano-nginx-unicorn).
+
+### Installation
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem 'capistrano', '~> 3.1'
+      gem 'capistrano-memcached', '~> 1.0'
+    end
+
+And then:
+
+    $ bundle install
+
+### Setup and usage
+
+Add this line to `Capfile`
+
+    require 'capistrano/memcached'
+
+**Setup task**
+
+Make sure the `deploy_to` path exists and has the right privileges on the
+server (i.e. `/var/www/myapp`).<br/>
+Or just install
+[capistrano-safe-deploy-to](https://github.com/bruno-/capistrano-safe-deploy-to)
+plugin and don't think about it.
+
+To setup the memcached server run:
+
+    $ bundle exec cap production setup
+    
+This will generate the memcached.conf and a memcached.yml file with the hostname + port
+where memcached is running. This can be used to configure Dalli, for example.
+
+### Configuration
+
+As described in the Usage section, this plugin works with minimal setup.
+However, configuration is possible.
+
+You'll find the options and their defaults below.
+
+In order to override the default, put the option in the stage file, for example:
+
+    # in config/deploy/production.rb
+    set :memcached_listen_port, 11212
+
+Defaults are listed near option name in the first line.
+
+* `set :memcached_memory_limit` # defaults to 128<br/>
+The memory limit of memcached in MB.
+
+* `set :memcached_log_file, "/var/log/memcached.log"`<br/>
+Location of memcached log file.
+
+* `set :memcached_port, "11211"`<br/>
+The port memcached listens on.
+
+* `set :memcached_ip, "127.0.0.1" # default listen only on localhost (for security) `<br/>
+The IP memcached listens on.
+
+* `set :memcached_roles, [:app]`<br/>
+The roles on which memcached will be installed. `memcached.yml` will be available to all :app roles.
+
+* `set :memcached_user, "memcache"`<br/>
+The user account used by memcached.
+
+
+### Template customization
+
+If you want to change default templates, you can generate them using
+`rails generator`:
+
+    $ bundle exec rails g capistrano:memcached:config
+
+This will copy default templates to `config/deploy/templates` directory, so you
+can customize them as you like, and capistrano tasks will use this templates
+instead of default.
+
+You can also provide path, where to generate templates:
+
+    $ bundle exec rails g capistrano:memcached:config config/templates
+
+    
+### TODO
+* SASL authentication setup for memcached when running on multiple servers. 
+    
+### More Capistrano automation?
+
+If you'd like to streamline your Capistrano deploys, you might want to check
+these zero-configuration, plug-n-play plugins:
+
+- [capistrano-unicorn-nginx](https://github.com/bruno-/capistrano-unicorn-nginx)<br/>
+no-configuration unicorn and nginx setup with sensible defaults
+- [capistrano-postgresql](https://github.com/bruno-/capistrano-postgresql)<br/>
+plugin that automates postgresql configuration and setup
+- [capistrano-rbenv-install](https://github.com/bruno-/capistrano-rbenv-install)<br/>
+would you like Capistrano to install rubies for you?
+- [capistrano-safe-deploy-to](https://github.com/bruno-/capistrano-safe-deploy-to)<br/>
+if you're annoyed that Capistrano does **not** create a deployment path for the
+app on the server (default `/var/www/myapp`), this is what you need!
+
+### Bug reports and pull requests
+
+...are very welcome!
+
+### Thanks
+
+[@bruno-](https://github.com/bruno-) - for his
+[capistrano-unicorn-nginx](https://github.com/bruno-/capistrano-unicorn-nginx) plugin on which this
+one is heavily based.

data/Rakefile

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

data/capistrano-memcached.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/memcached/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-memcached"
+  gem.version       = Capistrano::Memcached::VERSION
+  gem.authors       = ["Ruben Stranders"]
+  gem.email         = ["r.stranders@gmail.com"]
+  gem.description   = <<-EOF.gsub(/^\s+/, '')
+    Capistrano tasks for automatic and sensible memcached configuration.
+
+    Enables zero downtime deployments of Rails applications. Configs can be
+    copied to the application using generators and easily customized.
+
+    Works *only* with Capistrano 3+.
+
+    Heavily inspired (i.e. copied and reworked) by https://github.com/bruno-/capistrano-unicorn-nginx
+  EOF
+  gem.summary       = "Capistrano tasks for automatic and sensible memcached configuration."
+  gem.homepage      = "https://github.com/rhomeister/capistrano-memcached"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "capistrano", ">= 3.1"
+  gem.add_dependency "sshkit", ">= 1.2.0"
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano/dsl/memcached_paths.rb

@@ -0,0 +1,14 @@
+module Capistrano
+  module DSL
+    module MemcachedPaths
+
+      def memcached_config_file
+        "/etc/memcached.conf"
+      end
+
+      def memcached_default_app_config_file
+        shared_path.join('config/memcached.yml')
+      end
+    end
+  end
+end

data/lib/capistrano/memcached/helpers.rb

@@ -0,0 +1,34 @@
+require 'erb'
+
+module Capistrano
+  module Memcached
+    module Helpers
+
+      def mem_template(template_name)
+        config_file = "#{fetch(:templates_path)}/#{template_name}"
+        # if no customized file, proceed with default
+        unless File.exists?(config_file)
+          config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/memcached/templates/#{template_name}")
+        end
+        StringIO.new(ERB.new(File.read(config_file)).result(binding))
+      end
+
+      def file_exists?(path)
+        test "[ -e #{path} ]"
+      end
+
+      def deploy_user
+        capture :id, '-un'
+      end
+
+      def sudo_upload!(from, to)
+        filename = File.basename(to)
+        to_dir = File.dirname(to)
+        tmp_file = "#{fetch(:tmp_dir)}/#{filename}"
+        upload! from, tmp_file
+        sudo :mv, tmp_file, to_dir
+      end
+
+    end
+  end
+end

data/lib/capistrano/memcached/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Memcached
+    VERSION = "1.0.0"
+  end
+end

data/lib/capistrano/memcached.rb

@@ -0,0 +1,2 @@
+require 'capistrano/dsl/memcached_paths'
+load File.expand_path("../tasks/memcached.rake", __FILE__)

data/lib/capistrano/tasks/memcached.rake

@@ -0,0 +1,67 @@
+require 'capistrano/dsl/memcached_paths'
+require 'capistrano/memcached/helpers'
+
+include Capistrano::Memcached::Helpers
+include Capistrano::DSL::MemcachedPaths
+
+namespace :load do
+  task :defaults do
+    set :memcached_memory_limit, 128
+    set :memcached_log_file, "/var/log/memcached.log"
+    set :memcached_port, 11211
+    set :memcached_ip, "127.0.0.1" # listen only on localhost (for security)
+
+    # this is where memcached will be installed. A handy memcached.yml file will be created on all :app roles in
+    # shared/config
+    set :memcached_roles, [:app]
+    set :memcached_user, "memcache"
+
+    set :memcached_app_config, -> { memcached_default_app_config_file }
+
+  end
+end
+
+namespace :memcached do
+
+  desc "Setup Memcached config file"
+  task :setup do
+    on roles fetch(:memcached_roles) do
+      sudo "useradd #{fetch(:memcached_user)}; true" # create user, but don't fail if it already exists
+      sudo "apt-get", "-y install memcached"
+
+      sudo_upload! mem_template("memcached.erb"), memcached_config_file
+      invoke "memcached:restart"
+    end
+  end
+
+  desc 'Setup Memcached app configuration'
+  task :setup_app_config do
+    on roles :app do
+      execute :mkdir, '-pv', File.dirname(fetch(:memcached_app_config))
+      upload! mem_template('memcached.yml.erb'), fetch(:memcached_app_config)
+    end
+  end
+
+  task :memcached_yml_symlink do
+    on roles :app do
+      set :linked_files, fetch(:linked_files, []).push("config/memcached.yml")
+    end
+  end
+
+  before 'deploy:symlink:linked_files', 'memcached:memcached_yml_symlink'
+
+  %w[start stop restart].each do |command|
+    desc "#{command} Memcached"
+    task command do
+      on roles fetch(:memcached_roles) do
+        sudo :service, "memcached #{command}"
+      end
+    end
+  end
+end
+
+desc 'Server setup tasks'
+task :setup do
+  invoke 'memcached:setup'
+  invoke 'memcached:setup_app_config'
+end

data/lib/generators/capistrano/memcached/USAGE.md

@@ -0,0 +1,9 @@
+To create local memcached configuration files call
+
+    bundle exec rails generate capistrano:memcached:config [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    bundle rails generate capistrano:memcached:config "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/capistrano/memcached/config_generator.rb

@@ -0,0 +1,17 @@
+module Capistrano
+  module Memcached
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        desc "Create local memcached configuration files for customization"
+        source_root File.expand_path('../templates', __FILE__)
+        argument :templates_path, type: :string,
+          default: "config/deploy/templates",
+          banner: "path to templates"
+
+        def copy_template
+          copy_file "memcached.erb", "#{templates_path}/memcached.erb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/capistrano/memcached/templates/memcached.erb

@@ -0,0 +1,15 @@
+# run as a daemon
+-d
+
+logfile <%= fetch(:memcached_log_file) %>
+
+# memory limit
+-m <%= fetch(:memcached_memory_limit) %>
+
+# port
+-p <%= fetch(:memcached_port) %>
+
+# user
+-u <%= fetch(:memcached_user) %>
+
+-l <%= fetch(:memcached_ip) %>

data/lib/generators/capistrano/memcached/templates/memcached.yml.erb

@@ -0,0 +1,2 @@
+<%= fetch(:stage) %>:
+  host: '127.0.0.1:11211'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-memcached
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ruben Stranders
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Capistrano tasks for automatic and sensible memcached configuration.
+
+  Enables zero downtime deployments of Rails applications. Configs can be
+
+  copied to the application using generators and easily customized.
+
+  Works *only* with Capistrano 3+.
+
+  Heavily inspired (i.e. copied and reworked) by https://github.com/bruno-/capistrano-unicorn-nginx
+
+'
+email:
+- r.stranders@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-memcached.gemspec
+- lib/capistrano-memcached.rb
+- lib/capistrano/dsl/memcached_paths.rb
+- lib/capistrano/memcached.rb
+- lib/capistrano/memcached/helpers.rb
+- lib/capistrano/memcached/version.rb
+- lib/capistrano/tasks/memcached.rake
+- lib/generators/capistrano/memcached/USAGE.md
+- lib/generators/capistrano/memcached/config_generator.rb
+- lib/generators/capistrano/memcached/templates/memcached.erb
+- lib/generators/capistrano/memcached/templates/memcached.yml.erb
+homepage: https://github.com/rhomeister/capistrano-memcached
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Capistrano tasks for automatic and sensible memcached configuration.
+test_files: []