capistrano-sdb 0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+
+v0.1. 2008/10/27
+* Basic functionality. Two precedence modes.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Jamis Buck
+
+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/Manifest

@@ -0,0 +1,7 @@
+capistrano-sdb.gemspec
+CHANGELOG
+lib/capistrano/sdb.rb
+Manifest
+MIT-LICENSE
+Rakefile
+README

data/README

@@ -0,0 +1,51 @@
+= Capistrano SDB
+
+Allows you to use Amazon Simple DB as a repository for any capistrano config keys.
+
+== INSTALLATION
+In your Capfile, add:
+require 'capistrano/sdb'
+
+== DEPENDENCIES
+
+* right_aws
+
+== USAGE
+
+In your deploy.rb, you must set:
+
+ set :aws_access_key_id, '<your access key>'
+ set :aws_secret_access_key, '<your secret>'
+
+The SDB plugin works in two precedence modes; :local, and :remote
+
+== PRECEDENCE MODES
+
+You can set precedence modes using a directive in your deploy.rb: e.g.
+	set :sdb_precedence, :remote 
+or from the command line, e.g.
+	cap SDB_PRECEDENCE=remote deploy
+
+
+=== LOCAL (default)
+
+It is assumed that anything stored in the local file(s) 
+overrides SDB configuration. 
+
+In this mode, calls to SDB are made only when keys are not found locally,
+so you will not see any difference for keys that are found.
+
+In this mode, you can slowly remove almost all config from your local filesystem,
+and move it to SDB - thereby keeping your local files quite clean.
+
+=== REMOTE
+
+Here we assume that any overrides are stored in SDB, and local files are used 
+as a backup.
+
+The downside of this mode is that any task will first require a download of your 
+configuration
+
+== CONFIGURATION OPTIONS
+
+* sdb_domain : override the default sdb domain of "#{application}_cap_config"

data/Rakefile

@@ -0,0 +1,9 @@
+require 'echoe'
+Echoe.new('capistrano-sdb') do |p|
+  p.author = "Hemant Bhanoo"
+  p.summary = "Allows you to use Amazon Simple DB as a repository for any capistrano config keys."
+  p.url = "http://code.google.com/p/capistrano-sdb/"
+  p.runtime_dependencies = ["right_aws >= 1.8.1", "json"]
+  p.install_message = <<-MSG
+MSG
+end

data/capistrano-sdb.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{capistrano-sdb}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hemant Bhanoo"]
+  s.date = %q{2008-10-30}
+  s.description = %q{Allows you to use Amazon Simple DB as a repository for any capistrano config keys.}
+  s.email = %q{}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/capistrano/sdb.rb", "README"]
+  s.files = ["capistrano-sdb.gemspec", "CHANGELOG", "lib/capistrano/sdb.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README"]
+  s.has_rdoc = true
+  s.homepage = %q{http://code.google.com/p/capistrano-sdb/}
+  s.post_install_message = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Capistrano-sdb", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{capistrano-sdb}
+  s.rubygems_version = %q{1.3.0}
+  s.summary = %q{Allows you to use Amazon Simple DB as a repository for any capistrano config keys.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<right_aws>, [">= 0", "= 1.8.1"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<right_aws>, [">= 0", "= 1.8.1"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<right_aws>, [">= 0", "= 1.8.1"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/lib/capistrano/sdb.rb

@@ -0,0 +1,235 @@
+require 'rubygems'
+require 'right_aws'
+require 'json'
+
+module SDB # :nodoc:all
+  class Logger < ::Logger 
+    LEVEL_MAPPING = {
+      :debug => :trace,
+      :info => :debug,
+      :warn =>:info,
+      :error =>:important,
+      :fatal => :important
+    }
+    
+    LEVEL_MAPPING.each do |k,v|
+      define_method( k ) do |*args|
+        @caplogger.send( v, *args )
+      end
+    end
+    
+    def initialize( caplogger )
+      @caplogger = caplogger
+    end
+    
+  end
+end # module SDB
+
+module Capistrano #:nodoc:
+  class Configuration #:nodoc:
+    module Variables #:nodoc:
+      module SDB
+        def self.included( base ) #:nodoc:
+          %w(initialize respond_to? method_missing).each do |m|
+            base_name = m[/^\w+/]
+            punct     = m[/\W+$/]
+            base.send :alias_method, "#{base_name}_without_sdb_variables#{punct}", m
+            base.send :alias_method, m, "#{base_name}_with_sdb_variables#{punct}"
+          end # each m
+        end # self.included
+
+        def initialize_with_sdb_variables(*args) #:nodoc:
+          initialize_without_sdb_variables(*args)
+        end # def initialize_with_sdb_variables
+
+        def respond_to_with_sdb_variables?( sym ) #:nodoc:
+          return respond_to_without_sdb_variables?( sym ) if( @_sdb_booting )
+          if( sdb_local_override? )
+            return true if( respond_to_without_sdb_variables?( sym ) )
+            sdb_download_config
+            return sdb_has_key?( sym )
+          else
+            sdb_download_config
+            return sdb_has_key?( sym ) || respond_to_without_sdb_variables?( sym )
+          end
+        end # def respond_to_with_sdb_variables?
+
+        def method_missing_with_sdb_variables( sym, *args, &block ) #:nodoc:
+          return method_missing_without_sdb_variables( sym , *args, &block ) if( @_sdb_booting )
+          if( args.length == 0 && block.nil? )
+            if( sdb_local_override? )
+              if( respond_to_without_sdb_variables?( sym ) )
+                method_missing_without_sdb_variables( sym, *args, &block )
+              else
+                sdb_download_config
+                sdb_fetch( sym )
+              end
+            else # if sdb_local_override?
+              sdb_has_key?( sym )  ? sdb_fetch( sym ) : method_missing_without_sdb_variables( sym, *args, &block )
+            end # if sdb_local_override? else
+            
+          else #
+            method_missing_without_sdb_variables( sym, *args, &block )
+          end # possible var
+          
+        end # def method_missing_with_sdb_variables
+
+        # Boot the sdb system, including 
+        # * creating a client
+        # * creating a domain for configuration
+        def require_sdb( opts = nil )
+          opts ||= {}
+          return if @booted
+          @_sdb_booting = true
+          raise "must specify aws_access_key_id and aws_secret_access_key" unless
+            ( exists?( :aws_access_key_id ) && exists?( :aws_secret_access_key ) )
+          @stage = respond_to?( :stage ) ? stage : 'default'
+          load_precedence_setting
+          raise "no stage specified" if @stage.nil?
+          logger.trace "booting sdb plugin with #{@precedence} precedence"
+          default_client_params = {
+            :protocol => 'http',
+            :port => 80,
+            :logger => ::SDB::Logger.new( logger )
+          }
+          override_client_params = respond_to?( :sdb_client_params ) ? sdb_client_params : {}
+          client_params = default_client_params.merge( override_client_params )
+          self._sdb_client = RightAws::SdbInterface.new( aws_access_key_id, aws_secret_access_key, 
+                                                         client_params )
+                                                         
+          default_domain = ENV['SDBSELF._SDB_DOMAIN'] || "#{application}_cap_config"
+          self._sdb_domain = default_domain
+          self._sdb_domain = sdb_domain if( exists?(:sdb_domain) )
+          self._sdb_client.create_domain( self._sdb_domain )
+          @_sdb_booting = false
+          @booted = true
+        end
+
+        # tests whether the sdb config defines a variable or not
+        # pass in :reload as the second param to force a re-download of config.
+        def sdb_has_key?( variable, reload = false )
+          sdb_download_config( reload )
+          return @sdb_vars.has_key?( variable.to_s )
+        end
+
+        # fetches a variable from sdb.
+        # pass in :reload as the second param to force a re-download of config.
+        def sdb_fetch( variable, reload = false )
+          logger.trace( "fetching #{variable} for #{@stage} from remote location" )
+          sdb_download_config( reload )
+          if( variable )
+            raise IndexError, "`#{variable} not found" if( !sdb_has_key?( variable ) )
+            return @sdb_vars[variable.to_s]
+          else
+            return @sdb_vars
+          end
+        end
+
+        # takes in a hash of variables to set.
+        def sdb_set( variables )
+          require_sdb
+          rval = self._sdb_client.put_attributes( self._sdb_domain, @stage, variables )
+        end
+
+        protected
+        attr_accessor :_sdb_client, :_sdb_domain
+
+        private
+
+        # dump internal variable state
+        def sdb_dump_vars( reload = false ) 
+          sdb_download_config( reload )
+          logger.debug "sdb config:\n #{@sdb_vars.inspect}"
+        end
+
+
+        def sdb_download_config( reload = false )
+          return @sdb_vars if( !reload && @sdb_vars )
+          require_sdb
+          logger.trace "downloading configuration from sdb"
+          # FIXME: we might still want to download data for all stages, just so 
+          # that we can do a stage -> default fallback even for remote.
+#           @sdb_vars = Hash[ *(self._sdb_client.query( self._sdb_domain )[:items].collect{ |item|
+#                     [item, self._sdb_client.get_attributes( self._sdb_domain, @stage )[:attributes]
+#                     ]}.flatten) ]
+          @sdb_vars = self._sdb_client.get_attributes( self._sdb_domain, @stage )[:attributes]
+        end
+
+        def sdb_booted?
+          return @booted
+        end
+
+        def load_precedence_setting
+          if( @precedence.nil? )
+            if( ENV['SDB_PRECEDENCE'] )
+              @precedence = ENV['SDB_PRECEDENCE'].to_sym
+            else
+              wasbooting = @_sdb_booting
+              @_sdb_booting = true
+              @precedence = self.respond_to?( :sdb_precedence ) ? sdb_precedence : :local
+              @_sdb_booting = wasbooting
+            end
+          end
+        end
+
+        def sdb_local_override?
+          load_precedence_setting
+          :local == @precedence
+        end
+
+        def sdb_has_stage_info?( stage )
+          return @sdb_vars && @sdb_vars.has_key?( stage.to_s )
+        end
+
+      end # module SDB
+    end # module Variables
+  end # class Configuration
+end # module Capistrano
+
+Capistrano::Configuration.send( :include, Capistrano::Configuration::Variables::SDB )
+
+Capistrano::Configuration.instance.load do
+  namespace :sdb do 
+
+    desc <<-DESC
+    Store a variable in SDB. 
+    Takes two forms
+    * single key/value set
+      $ cap KEY=msg VALUE=something sdb:set
+
+    * multiple kv pairs (JSON compliant string)
+      $ cap VARS='{"myarray" : [1,2,3]}'
+DESC
+    task :set do
+      key, value = ENV['KEY'], ENV['VALUE']
+      varstring = ENV['VARS']
+      abort "Either specify a KEY and VALUE or a json VARS string. cap -e sdb:set for more info" if
+        ( varstring.nil? && ( key.nil? || value.nil? ) )
+      if( varstring )
+        vars = JSON.parse( varstring )
+      else
+        vars = { key => value }
+      end
+      sdb_set( vars )
+    end
+
+    desc <<-DESC
+    Dump the config stored in SDB. 
+      Takes two forms:
+      * single key:
+           $ cap KEY=msg sdb:show
+      * full dump:
+           $ cap sdb:show
+DESC
+    task :show do
+      key = ENV['KEY']
+      value = sdb_fetch( key )
+      if( key )
+        puts "`#{key} = #{value.inspect}"
+      else
+        logger.important( "all keys':\n #{value.inspect}" )
+      end
+    end
+
+  end # namespace sdb
+end # Configuration.instance.load

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-sdb
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Hemant Bhanoo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: right_aws
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.8.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Allows you to use Amazon Simple DB as a repository for any capistrano config keys.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/capistrano/sdb.rb
+- README
+files: 
+- capistrano-sdb.gemspec
+- CHANGELOG
+- lib/capistrano/sdb.rb
+- Manifest
+- MIT-LICENSE
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://code.google.com/p/capistrano-sdb/
+post_install_message: ""
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Capistrano-sdb
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: capistrano-sdb
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: Allows you to use Amazon Simple DB as a repository for any capistrano config keys.
+test_files: []
+