lifeboat 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+#
+gem 'right_aws', '1.10.0'
+gem 'activerecord', '2.1.2'
+
+group :development do
+  gem "rspec", "2.5.0"
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.1.2)
+      activesupport (= 2.1.2)
+    activesupport (2.1.2)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    right_aws (1.10.0)
+      right_http_connection (>= 1.2.4)
+    right_http_connection (1.3.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 2.1.2)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  right_aws (= 1.10.0)
+  rspec (= 2.5.0)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ivan Acosta-Rubio
+
+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,109 @@
+Lifeboat
+========
+
+![LifeBoat](https://github.com/ivanacostarubio/lifeboat/raw/master/support/lifeboat.png)
+
+Lifeboat is a drop in module for any Ruby Object that responds to 3 callbacks. 
+
+It monitors your models for create, update and delete events. 
+
+It sends a serialized copy of the model attributes to Amazon SQS when those events happen.  
+
+The serialized records are JSON.
+
+
+WHY
+---
+
+If you're operating a web service and you're smart, then you make frequent
+backups.  But if you're operating a popular web service then no backup will
+ever be fresh enough when you have a failure.  A lot of people learned that
+lesson the hard way during the Great Amazon EBS Meltdown of 2011.  How do
+you recover data that was created after your most-recent backup, but before
+your database crashed?  One way to do that is with database replication.
+But not everybody has that option.  Another way to do it is to send your data
+to the lifeboats as soon as it's created, so that you can recover it after
+a disaster.
+
+
+
+Requirements
+------------
+* Amazon SQS
+* right_aws gem
+
+Installation
+------------
+
+Include the gem in your Gemfile:
+
+    gem "lifeboat"
+
+Quick Start
+-----------
+
+    class AnyObject < ActiveRecord::Base
+     include LifeBoat
+    end
+
+
+** We will then automatically create queue messages each time any instance of the model class is created, updated, or deleted. ** 
+
+How did we named the queues
+---------------------------
+
+** ction_model **
+
+** Where: **  action can be: create, update and delete
+** Where: ** model can be the name of any model we include lifeboat on. 
+
+
+ASSUMPTIONS
+-----------
+
+We Asume you have a file called aws.yml under you config directory with the aws key and secret
+
+    test:
+      :key 'you_key'
+      :secret 'your_secret'
+
+
+Hot-Swap Slaves
+---------------
+
+The real purpose of data replication is to maintain hot-swappable backup servers.  When your
+production server goes down you can failover to one of your backups.  If you're worried about
+your entire cloud-based data center going down suddenly for days at a time (it happens!) then
+you can run a hot-swap slave in a different data center, and periodically monitor the message
+queues generated by Lifeboat in your production, using the Lifeboat rake task:
+
+  rake lifeboat:update
+
+Lifeboat is configured exactly the same for the master and for the slaves, so you can use
+the exact same code base in both locations.  Lifeboat's update Rake task is idempotent,
+so you can run it as frequently as you like.  And Lifeboat slaves do not destroy records
+from the message queues, so you can run as many different slave nodes as you like.
+
+Contributing
+------------
+
+If you'd like to contribute a feature or bugfix: Thanks! To make sure your
+fix/feature has a high chance of being included, please read the following
+guidelines:
+ 
+1. Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+2. Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+3. Fork the project
+4. Start a feature/bugfix branch
+5. Commit and push until you are happy with your contribution
+6. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+7. Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Credits
+-------
+
+Buit by Ivan.
+
+Designed by Ivan & Ryan.
+
+Inspired by Amazon.  (And not in a good way.)

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "lifeboat"
+  gem.homepage = "http://github.com/ivanacostarubio/lifeboat"
+  gem.license = "MIT"
+  gem.summary = %Q{sends messages to SQS}
+  gem.description = %Q{ }
+  gem.email = "ivan@bakedweb.net"
+  gem.authors = ["Ivan Acosta-Rubio"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lifeboat #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config/aws.yml

@@ -0,0 +1,3 @@
+test:
+  key: 'AKIAJ3GG5YKJUT3YQQYA'
+  secret: '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'

data/config/database.yml

@@ -0,0 +1,4 @@
+test:
+  adapter: mysql
+  username: root
+  database: lifeboat_test

data/lib/lifeboat.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'right_aws'
+require 'active_record'
+require 'yaml'
+
+
+class Credentials
+  def initialize
+# TRIED USING THE INITIALIZE FOR THOSE YAML LOADING DOWN THERE
+# BUT IT WAS GIVING ME CRAP AND HAD TO DUPLICATE THE LINE
+# MY GUEST IS THAT IT IS B/C THEY ARE CLASS METHODS
+# TODO: RESEARCH HOW TO REFACTOR OUT
+  end
+
+  def self.key
+    Rails.root['test']['key']
+  end
+  def self.secret
+    Rails.root['test']['secret']
+  end
+end
+
+
+module LifeBoat
+  def self.included(base)
+    raise "Object Lacks Proper Callbacks" unless base.respond_to? :after_create
+    base.class_eval do
+      after_create :create_lifeboat
+      after_destroy :destroy_lifeboat
+      after_update :update_lifeboat
+    end
+  end
+
+  def self.read_queue(name)
+    #TODO EXTRAT OUT THE @CUE INTO HIGHER LEVEL
+    @cue = RightAws::SqsGen2.new(Credentials.key, Credentials.secret)
+    return @cue.queue(name).receive_messages
+  end
+
+  def after_initialize
+    @cue = RightAws::SqsGen2.new(Credentials.key, Credentials.secret)
+  end
+
+  [:create, :update, :destroy ].each do |action|
+    define_method(action.to_s + "_lifeboat") do
+      q = RightAws::SqsGen2::Queue.create(@cue, action.to_s+"_"+ self.class.to_s.downcase, true)
+      q.send_message(self.attributes.to_json)
+    end
+  end
+
+end

data/lifeboat.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{lifeboat}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ivan Acosta-Rubio"]
+  s.date = %q{2011-04-27}
+  s.description = %q{ }
+  s.email = %q{ivan@bakedweb.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "config/aws.yml",
+    "config/database.yml",
+    "lib/lifeboat.rb",
+    "lifeboat.gemspec",
+    "spec/lifeboat_spec.rb",
+    "support/lifeboat.png"
+  ]
+  s.homepage = %q{http://github.com/ivanacostarubio/lifeboat}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{sends messages to SQS}
+  s.test_files = [
+    "spec/lifeboat_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<right_aws>, ["= 1.10.0"])
+      s.add_runtime_dependency(%q<activerecord>, ["= 2.1.2"])
+      s.add_development_dependency(%q<rspec>, ["= 2.5.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<right_aws>, ["= 1.10.0"])
+      s.add_dependency(%q<activerecord>, ["= 2.1.2"])
+      s.add_dependency(%q<rspec>, ["= 2.5.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<right_aws>, ["= 1.10.0"])
+    s.add_dependency(%q<activerecord>, ["= 2.1.2"])
+    s.add_dependency(%q<rspec>, ["= 2.5.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/lifeboat_spec.rb

@@ -0,0 +1,121 @@
+require 'rubygems'
+require 'rspec'
+require 'lifeboat'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/../config/database.yml'))
+
+ActiveRecord::Base.logger =
+        ActiveSupport::BufferedLogger.new(File.dirname(__FILE__) + "/debug.log")
+
+ActiveRecord::Base.establish_connection(config['test'])
+
+def rebuild_model options = {}
+  ActiveRecord::Base.connection.create_table :fake_models, :force => true do |table|
+    table.column :name, :string
+    table.column :phone, :string
+    table.column :email, :string
+  end
+  ActiveRecord::Base.connection.create_table :fakes, :force => true do |table|
+    table.column :name, :string
+  end
+end
+
+rebuild_model
+
+class FakeModel < ActiveRecord::Base
+  attr_accessor :name, :email, :phone
+  include LifeBoat
+end
+
+class Fake < ActiveRecord::Base
+  attr_accessor :name
+  include LifeBoat
+end
+
+
+class Helper
+    def self.clean_all_queues
+       @sqs = RightAws::SqsGen2.new(Credentials.key,Credentials.secret)
+       @sqs.queues.each do |queue|
+         @sqs.queue(queue.name.to_s).clear
+       end
+    end
+end
+
+class Rails
+  def self.root
+    @credentials = YAML::load(IO.read(File.dirname(__FILE__) + '/../config/aws.yml'))
+  end
+end
+
+
+describe "An simple object " do
+  it "raises for not having callbacks" do
+    lambda{ class BadModel ; include LifeBoat ; end }.should raise_error
+  end
+end
+
+describe FakeModel, " We hook into callbacks to send the messages" do
+
+  it "does not raise when included in object with proper callbacks" do
+    lambda{ class FakeModel < ActiveRecord::Base ; include LifeBoat; end }.should_not raise_error
+  end
+  it "Fake Model responds to :after_create" do
+    after_create = FakeModel.respond_to? :after_create
+    after_create.should == true
+  end
+
+  it "Fake Model responds to :after_update" do
+    after_update = FakeModel.respond_to? :after_update
+    after_update.should == true
+  end
+
+  it "Fake Model Responds to :after_destroy" do
+    after_destroy = FakeModel.respond_to? :after_destroy
+    after_destroy.should == true
+  end
+end
+
+describe LifeBoat , " AWS Credentials"do
+  before(:each) do
+    Helper.clean_all_queues
+  end
+
+  it "Read the credentials from config/aws.yml" do
+    pending
+  end
+end
+
+describe LifeBoat  do
+
+  after(:each) do
+    Helper.clean_all_queues
+  end
+
+  it "reads messages from a cue" do
+    Fake.create(:name => "ivan")
+    messages = LifeBoat.read_queue("create_fake")
+    messages.size.should == 1
+  end
+
+  it "the message it creates contains the attributes ob the object as json" do
+    f = Fake.create(:name => "ivan")
+    q = LifeBoat.read_queue("create_fake")
+    q[0].body.should == f.attributes.to_json
+  end
+
+  it "deletes SQS queue when parent is deleted" do
+    f = Fake.create(:name => "updated")
+    f.destroy
+    messages = LifeBoat.read_queue("destroy_fake")
+    messages.size.should == 1
+  end
+
+  it "updates SQS queue when parent is updated" do
+    f = Fake.create(:name => "Er Update")
+    f.name= "28347834" ; f.save
+    messages= LifeBoat.read_queue("update_fake")
+    messages.size.should == 1
+  end
+
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification 
+name: lifeboat
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ivan Acosta-Rubio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-27 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 1
+        - 10
+        - 0
+        version: 1.10.0
+  requirement: *id001
+  prerelease: false
+  name: right_aws
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  requirement: *id002
+  prerelease: false
+  name: activerecord
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  requirement: *id003
+  prerelease: false
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  prerelease: false
+  name: shoulda
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id005
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id006
+  prerelease: false
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+  prerelease: false
+  name: rcov
+description: " "
+email: ivan@bakedweb.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- config/aws.yml
+- config/database.yml
+- lib/lifeboat.rb
+- lifeboat.gemspec
+- spec/lifeboat_spec.rb
+- support/lifeboat.png
+has_rdoc: true
+homepage: http://github.com/ivanacostarubio/lifeboat
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: sends messages to SQS
+test_files: 
+- spec/lifeboat_spec.rb