WatersOfOblivion-burn 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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

@@ -0,0 +1,21 @@
+=Burn
+
+Burn is a plugin for simplifying backups with the Crash backup server.
+
+==Dependencies
+
+This relies on the FootPedal[http://watersofoblivion.github.com/footpedal/] and
+ActiveResourceInstanceAuthentication[http://watersofoblivion.github.com/activeresourceinstanceauthentication/]
+plugins.
+
+==Gem
+
+This plugin is available as a Gem.  Add the following line to
+<tt>config/environment.rb</tt> and run <tt>rake gems:install</tt>.
+
+  config.gem "WatersOfOblivion-burn", :lib => "burn", :source => "http://gems.github.com/"
+
+This will also install the required dependencies if you have
+<tt>http://gems.github.com/</tt> as a source.
+
+Copyright (c) 2009 Jonathan Bryant, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the burn plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the burn plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Burn'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1,2 @@
+
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app/controllers/burn/burn_controller.rb

@@ -0,0 +1,34 @@
+module Burn
+  # A simple controller which allows for backups and restores.
+  #
+  # - <tt>GET /burn/backup</tt> gets the latest backup
+  # - <tt>POST /burn/restore</tt> restores to the backup posted as
+  #   <tt>params[:backup][:data]</tt>
+  class BurnController < ActionController::Base
+    # Gets the latest backup
+    def backup
+      respond_to do |format|
+        format.html { send_data build_backup }
+      end
+    end
+
+    # Restores from a backup
+    def restore
+      load_backup params[:backup][:data].read
+
+      respond_to do |format|
+        format.html { head :ok }
+      end
+    end
+
+    # This method is overridden by the initializer +build_backup+ method
+    def build_backup
+    end
+
+    # This method is overridden by the initializer +load_backup+ method
+    def load_backup data
+    end
+
+    private :build_backup, :load_backup
+  end
+end

data/lib/app/models/burn/crash.rb

@@ -0,0 +1,5 @@
+module Burn
+  # A simple RESTful XML interface to the Crash server
+  class Crash < ActiveResource::Base
+  end
+end

data/lib/burn.rb

@@ -0,0 +1,5 @@
+# Adds the load path for the contoller
+Rails::Initializer.run do |config|
+  config.load_paths << File.join(File.dirname(__FILE__), 'app', 'models')
+  config.load_paths << File.join(File.dirname(__FILE__), 'app', 'controllers')
+end

data/lib/initializer.rb

@@ -0,0 +1,51 @@
+module Burn
+  # An initializer to be placed in the <tt>config/initializers</tt> directory.
+  # This should be used like <tt>Rails::Initializer</tt>.
+  #
+  #   Burn::Initializer.run do |config|
+  #     config.crash_server = "http://my.crash.server:1234/"
+  #
+  #     # Etc.
+  #   end
+  class Initializer
+    # Yields a new initializer to the block
+    def self.run
+      yield new if block_given?
+    end
+
+    # Sets the default backup server
+    def crash_server= crash_server
+      Burn::Crash.site = crash_server
+    end
+
+    # This takes a block which creates the backup.  The block should return the
+    # raw backup data.  If the backup creates a tarball, then this method should
+    # return the contents of that tarball.
+    #
+    #   # A not terribly effective backup
+    #   config.build_backup do
+    #     ToplevelModel.find(1).to_xml
+    #   end
+    def build_backup &block
+      Burn::BurnController.class_eval do
+        remove_method :build_backup
+        define_method :build_backup, &block
+      end
+    end
+
+    # This takes a block which restores from the backup.  The block will receive
+    # the raw backup data.  If the backup created a tarball, then this method
+    # will receive the contents of that tarball.
+    #
+    #   # A not terribly effective restore
+    #   config.load_backup do |data|
+    #     ToplevelModel.new.from_xml(data).save
+    #   end
+    def load_backup &block
+      Burn::BurnController.class_eval do
+        remove_method :load_backup
+        define_method :load_backup, &block
+      end
+    end
+  end
+end

data/lib/routing_extension.rb

@@ -0,0 +1,23 @@
+module Burn
+  # Adds two simple routes for fetching backups and restoring from backups
+  #
+  #   ActionController::Routing::Routes.draw do |map|
+  #     map.burn_backup  # Creates the backup route 'GET /burn/backup'
+  #     map.burn_restore # Creates the restore route 'POST /burn/restore'
+  #     map.burn         # Creates both of the above routes
+  #   end
+  module RoutingExtension
+    def burn_backup
+      @set.add_route '/burn/backup', :controller => 'burn/burn', :action => "backup", :method => :get
+    end
+
+    def burn_restore
+      @set.add_route '/burn/restore', :controller => 'burn/burn', :action => "restore", :method => :post
+    end
+
+    def burn
+      burn_backup
+      burn_restore
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,14 @@
+# Load the model and controller
+require File.join(File.dirname(__FILE__), '..', 'lib', 'burn')
+require File.join('burn', 'crash')
+require File.join('burn', 'burn_controller')
+
+# Load the routing extension
+require File.join(File.dirname(__FILE__), '..', 'lib', 'routing_extension')
+ActionController::Routing::RouteSet::Mapper.send :include, Burn::RoutingExtension
+ActionController::Routing::Routes.draw do |map|
+  map.burn
+end
+
+# Load the initializer
+require File.join(File.dirname(__FILE__), '..', 'lib', 'initializer')

data/test/burn_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class BurnTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: WatersOfOblivion-burn
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jonathan Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-05 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: WatersOfOblivion-footpedal
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: watersofmemory@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- init.rb
+- install.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- uninstall.rb
+- rails/init.rb
+- test/burn_test.rb
+- lib/burn.rb
+- lib/initializer.rb
+- lib/routing_extension.rb
+- lib/app/models/burn/crash.rb
+- lib/app/controllers/burn/burn_controller.rb
+has_rdoc: true
+homepage: http://watersofoblivion.github.com/burn/
+post_install_message: 
+rdoc_options: 
+- --title
+- Burn
+- --line-numbers
+- --inline-source
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Rails plugin for backups using the Crash backup server
+test_files: 
+- test/burn_test.rb