auto_elasticache 1.0.0

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chad McGimpsey
+
+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,88 @@
+# EasyElasticache
+
+Automatically start and configure an AWS ElastiCache cluster from an Elastic Beanstalk environment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_elasticache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_elasticache
+
+### Configuration
+
+Execute the following command to create the `.ebextensions/elasticache.config` and `config/auto_elasticache.yml` files
+
+```bash
+$ auto_elasticache
+```
+
+Change the names of the created resources to match your application and environment, and change the cache size to the appropriate value.
+
+```yaml
+Resources:
+  AppNameEnvironmentElastiCache:                          <<<<<------
+    Type: AWS::ElastiCache::CacheCluster
+    Properties:
+      CacheNodeType: cache.m1.small                       <<<<<------
+      NumCacheNodes: 1
+      Engine : memcached
+      CacheSecurityGroupNames:
+        - Ref: AppNameEnvironmentCacheSecurityGroup       <<<<<------
+  AppNameEnvironmentCacheSecurityGroup:                   <<<<<------
+    Type: AWS::ElastiCache::SecurityGroup
+    Properties:
+      Description: "Lock cache down to webserver access only"
+  AppNameEnvironmentCacheSecurityGroupIngress:            <<<<<------
+    Type: AWS::ElastiCache::SecurityGroupIngress
+    Properties:
+      CacheSecurityGroupName: 
+        Ref: AppNameEnvironmentCacheSecurityGroup         <<<<<------
+      EC2SecurityGroupName:
+        Ref: AWSEBSecurityGroup
+```
+
+Add the AWS credentials for a IAM user/group that has the access to read Elastic Beanstalk data and create Elasticache instances to the `config/auto_elasticache.yml` file
+
+```yaml
+staging:
+  access_key_id: 'my_key_id'
+  secret_access_key: 'my_secret_key'
+```
+
+## Usage
+
+Add the following to your environment config file (e.g. `config/environments/staging.rb`)
+
+```ruby
+elasticache = AutoElasticache::Elasticache.new
+config.cache_store = :dalli_store, elasticache.servers
+```
+
+You can also add options
+
+```ruby
+elasticache = AutoElasticache::Elasticache.new
+config.cache_store = :dalli_store,
+  elasticache.servers,
+  {
+    :expires_in => 1.day,
+    :socket_timeout => 1,
+    :down_retry_delay => 2
+  }
+```
+
+## Contributing
+
+1. Fork it
+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/auto_elasticache.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_elasticache/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "auto_elasticache"
+  gem.version       = AutoElasticache::VERSION
+  gem.authors       = ["Chad McGimpsey"]
+  gem.email         = ["chad.mcgimpsey@gmail.com"]
+  gem.description   = %q{Automatically start and configure an AWS ElastiCache cluster from an Elastic Beanstalk environment}
+  gem.summary       = %q{AutoElasticache automatically starts an AWS ElastiCache cluster and configures Rails to use it. This gem requires that you are using AWS Elastic Beanstalk.}
+  gem.homepage      = "https://github.com/dignoe/auto_elasticache"
+
+  gem.add_dependency('aws-sdk')
+  gem.add_dependency('dalli-elasticache')
+
+  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"]
+end

data/bin/auto_elasticache

@@ -0,0 +1,60 @@
+#!/usr/bin/ruby
+
+require 'fileutils'
+
+ec_config_content = <<-FILE
+Resources:
+  AppNameEnvironmentElastiCache:
+    Type: AWS::ElastiCache::CacheCluster
+    Properties:
+      CacheNodeType: cache.m1.small
+      NumCacheNodes: 1
+      Engine : memcached
+      CacheSecurityGroupNames:
+        - Ref: AppNameEnvironmentCacheSecurityGroup
+  AppNameEnvironmentCacheSecurityGroup:
+    Type: AWS::ElastiCache::SecurityGroup
+    Properties:
+      Description: "Lock cache down to webserver access only"
+  AppNameEnvironmentCacheSecurityGroupIngress:
+    Type: AWS::ElastiCache::SecurityGroupIngress
+    Properties:
+      CacheSecurityGroupName: 
+        Ref: AppNameEnvironmentCacheSecurityGroup
+      EC2SecurityGroupName:
+        Ref: AWSEBSecurityGroup
+FILE
+
+file = '.ebextensions/elasticache.config'
+if File.exists?(file)
+  warn "`#{file}' already exists, overwriting"
+elsif File.exists?(file.downcase)
+  warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+elsif !File.exists?(File.dirname(file))
+  warn "[skip] directory `#{File.dirname(file)}' does not exist"
+else
+  puts "[add] writing `#{file}'"
+  File.open(file, "w") { |f| f.write(ec_config_content) }
+end
+
+
+aws_credentials_content = <<-FILE
+staging:
+  access_key_id: ''
+  secret_access_key: ''
+production:
+  access_key_id: ''
+  secret_access_key: ''
+FILE
+
+file = 'config/auto_elasticache.yml'
+if File.exists?(file)
+  warn "[skip] `#{file}' already exists"
+elsif File.exists?(file.downcase)
+  warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+elsif !File.exists?(File.dirname(file))
+  warn "[skip] directory `#{File.dirname(file)}' does not exist"
+else
+  puts "[add] writing `#{file}'"
+  File.open(file, "w") { |f| f.write(aws_credentials_content) }
+end

data/lib/auto_elasticache.rb

@@ -0,0 +1 @@
+require 'auto_elasticache/elasticache'

data/lib/auto_elasticache/elasticache.rb

@@ -0,0 +1,68 @@
+require "version"
+require 'dalli-elasticache'
+require 'aws-sdk'
+
+module AutoElasticache
+  class Elasticache
+    ENVIRONMENT_NAME_FILE = "/var/app/support/env_name"
+    SERVERS_FILE = "/var/app/support/elasticache_servers"
+    attr_accessor :config_endpoint
+
+    def initialize
+      @config_endpoint = config_endpoint
+    end
+
+    def servers
+      if File.exists?(SERVERS_FILE)
+        return File.read(SERVERS_FILE).split("\n")
+      else
+        elasticache = Dalli::ElastiCache.new(configuration_endpoint)
+        File.open(SERVERS_FILE, 'w') {|f| f.write(elasticache.servers.join("\n")) }
+        return elasticache.servers
+      end
+    end
+
+    def refresh_servers
+      elasticache = Dalli::ElastiCache.new(configuration_endpoint)
+      File.open(SERVERS_FILE, 'w') {|f| f.write(elasticache.servers.join("\n")) }
+      return elasticache.servers
+    end
+
+
+    private
+
+    def configuration_endpoint
+      aws_config
+
+      # Find the stack
+      cf = AWS::CloudFormation.new
+      env_name = environment_name
+      stack_name = cf.stacks.each {|s| break s.name if s.parameters["AWSEBEnvironmentName"] == env_name}
+
+      # Find the ElastiCache resource physical id
+      ec_id = cf.stacks[stack_name].resources.each {|r| break r.physical_resource_id if r.resource_type == "AWS::ElastiCache::CacheCluster"}
+
+      # Find the ElastiCache configuration endpoint
+      ec = AWS::ElastiCache.new
+      config_endpoint = ec.client.describe_cache_clusters(:cache_cluster_id => ec_id)[:cache_clusters].first[:configuration_endpoint]
+      "#{config_endpoint[:address]}:#{config_endpoint[:port]}"
+    end
+
+    def environment_name
+      if File.exists?(ENVIRONMENT_NAME_FILE)
+        return File.read(ENVIRONMENT_NAME_FILE)
+      else
+        instance_id = `/opt/aws/bin/ec2-metadata -i | awk '{print $2}'`.strip
+        aws_config
+        ec2 = AWS::EC2.new
+        env_name = ec2.instances[instance_id].tags["elasticbeanstalk:environment-name"]
+        File.open(ENVIRONMENT_NAME_FILE, 'w') {|f| f.write(env_name) }
+        env_name
+      end
+    end
+
+    def aws_config
+      @aws_config ||= AWS.config(YAML.load_file("config/auto_elasticache.yml")[Rails.env])
+    end
+  end
+end

data/lib/auto_elasticache/version.rb

@@ -0,0 +1,3 @@
+module AutoElasticache
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: auto_elasticache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Chad McGimpsey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dalli-elasticache
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically start and configure an AWS ElastiCache cluster from an
+  Elastic Beanstalk environment
+email:
+- chad.mcgimpsey@gmail.com
+executables:
+- auto_elasticache
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- auto_elasticache.gemspec
+- bin/auto_elasticache
+- lib/auto_elasticache.rb
+- lib/auto_elasticache/elasticache.rb
+- lib/auto_elasticache/version.rb
+homepage: https://github.com/dignoe/auto_elasticache
+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.24
+signing_key: 
+specification_version: 3
+summary: AutoElasticache automatically starts an AWS ElastiCache cluster and configures
+  Rails to use it. This gem requires that you are using AWS Elastic Beanstalk.
+test_files: []