glacier_on_rails 0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e295a934008444dea879a7321b54127bff14fdd4
+  data.tar.gz: e05e01e722128b66382cd7fe070c3f3c52b5e131
+SHA512:
+  metadata.gz: 73eb06569b54dbd7b05fb855b9c4e4272a3c9db778562098504da9a7bd3ab693d5efbd08bb4a819c73a8b45cbb8a58004908a64454c699ac6f85a2076afef033
+  data.tar.gz: b656b92d745483062fb790663a6cd6ea873e0f898dd2025e481fe8833197970ae2e18dfca36838d30b44036e0c23993c548738e3afc7eb9fa36d71f40e88195a

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+.DS_Store
+sns_notes.md
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in glacier_on_rails.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+gem "pg"
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+gem 'webmock', :git => 'https://github.com/lazylester/webmock.git' # contains a patch... use this fork until the primary sources merges the patch
+
+gem "aws-sdk", "~> 2"

data/Gemfile.lock

@@ -0,0 +1,231 @@
+GIT
+  remote: https://github.com/lazylester/webmock.git
+  revision: 1e056477da4041174cc1b53f432595fb9e1f565c
+  specs:
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PATH
+  remote: .
+  specs:
+    glacier_on_rails (0.0.1)
+      httparty
+      rails (~> 5.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
+      globalid (>= 0.3.6)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
+      arel (~> 7.0)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    arel (7.1.4)
+    aws-sdk (2.9.14)
+      aws-sdk-resources (= 2.9.14)
+    aws-sdk-core (2.9.14)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.9.14)
+      aws-sdk-core (= 2.9.14)
+    aws-sigv4 (1.0.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    childprocess (0.6.3)
+      ffi (~> 1.0, >= 1.0.11)
+    cliver (0.3.2)
+    coffee-rails (4.2.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.2.x)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    database_cleaner (1.5.3)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    execjs (2.7.0)
+    ffi (1.9.18)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    haml (4.0.7)
+      tilt
+    haml-rails (1.0.0)
+      actionpack (>= 4.0.1)
+      activesupport (>= 4.0.1)
+      haml (>= 4.0.6, < 6.0)
+      html2haml (>= 1.0.1)
+      railties (>= 4.0.1)
+    hashdiff (0.3.4)
+    html2haml (2.1.0)
+      erubis (~> 2.7.0)
+      haml (~> 4.0)
+      nokogiri (>= 1.6.0)
+      ruby_parser (~> 3.5)
+    httparty (0.15.5)
+      multi_xml (>= 0.5.2)
+    i18n (0.8.1)
+    jmespath (1.3.1)
+    jquery-rails (4.3.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.5)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    multi_xml (0.6.0)
+    mysql2 (0.4.5)
+    nio4r (2.0.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    pg (0.20.0)
+    poltergeist (1.14.0)
+      capybara (~> 2.1)
+      cliver (~> 0.3.1)
+      websocket-driver (>= 0.2.0)
+    public_suffix (2.0.5)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby_parser (3.9.0)
+      sexp_processor (~> 4.1)
+    rubyzip (1.2.1)
+    safe_yaml (1.0.4)
+    selenium-webdriver (3.4.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0)
+    sexp_processor (4.9.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.7)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket (1.2.4)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+    xpath (2.1.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk (~> 2)
+  byebug
+  capybara (~> 2.4.0)
+  coffee-rails
+  database_cleaner
+  glacier_on_rails!
+  haml-rails
+  jquery-rails
+  mysql2
+  pg
+  poltergeist
+  rspec-rails
+  selenium-webdriver
+  webmock!
+
+BUNDLED WITH
+   1.15.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,98 @@
+# GlacierOnRails
+
+Rails engine with utilities for backup and restore of entire application database to the Amazon AWS Glacier service.
+Includes rake tasks that may be invoked by cron task to archive a daily backup.
+Archives both the database and attached files, where the storage of attached files follows the scheme of the [refile gem](https://github.com/refile/refile). Specifically, attached files are immutable, two files with the same filename are presumed to be identical. If a file exists in the attached files directory, it is not restored from the archive during a restore operation. All files in the attached files directory are archived individually, exactly once.
+
+Include this in your application Gemfile:
+
+```
+gem 'glacier_on_rails', :git => 'git://github.com/lazylester/glacier_on_rails.git'
+```
+
+The _index partial is intended for inclusion into a page in the main application.
+
+Dependencies required to be present in the main application are:
+* jQuery
+* ractive.js
+* underscore.js
+
+Run model test suites with:
+```
+  rspec spec/models
+```
+
+Run feature specs with:
+```
+  rspec spec/features
+```
+
+Run all the tests with:
+```
+  rake
+```
+
+Configure in the main application, in config/initializers/glacier_on_rails.rb:
+```ruby
+  if defined? GlacierOnRails
+    require 'glacier_on_rails/config'
+    GlacierOnRails::Config.setup do |config|
+      config.attached_files_directory = FileUploadLocation.join('store')
+      config.aws_region = 'us-east-1'
+    end
+
+    AwsLog.logger.level = 'debug' # possible values are: 'debug', 'info', 'warn', 'error', 'fatal'
+                                  # 'debug' is the most liberal, 'fatal' the most restrictive
+  end
+```
+## Cron control
+The rake task:
+```
+rake aws:create_db_archive
+```
+may be invoked from your cron job in order to create a periodic, automatic backup.
+
+## GlacierArchive model and its lifecycle
+
+The database and each of the file attachments are archived and restored individually, this dramatically reduces the resources consumed by backup, including Glacier storage and network bandwidth, since most of the file attachments are likely unchanged between backups, so it is unnecessary to back them up periodically.
+
+It is assumed that file attachments to Rails models are handled in the manner of the [refile gem](https://github.com/refile/refile). Each file is given a unique name for storage, and the files are never changed. If a file attached to an ActiveRecord model is replaced, it is given a new unique name. Attached files are individually backed up to AWS Glacier, if an attached file has already been backed up to AWS Glacier, the backup is skipped.
+
+Similarly during restoral, if a file exists in the attached files directory, it is not retrieved from AWS Glacier.
+
+The ApplicationDataBackup model manages the backup and restoral of the database and all file attachments.
+
+The GlacierArchive model has a retrieval_status property, indicating its lifecycle status:
+
+Status    | Meaning
+----------|-----------------------------------------------------------------------------------------------------------------------
+exists    | The attached file is present in the filesystem, retrieval/restoral presumed unnecessary.
+available | The attached file (or database backup file) has previously been archived to Glacier.
+pending   | An archive retrieval job has been initiated at Glacier, notification of completion is awaited (can take a few hours).
+ready     | Notification has been received that the archive is ready for download.
+local     | The archive has been downloaded and is present locally, available for restoral.
+
+## Database backup and restore
+Database tables application_data_backups and glacier_archives are used to store objects related to this gem. So database restoral is selective and excludes these two tables. This is so that the database can be restored to its version of (say) one week ago, and can subsequently be restored to its version from yesterday, even though the week-ago version did not contain ApplicationDataBackup and GlacierArchiv objects from yesterday.
+
+This is achieved using the pg_restore selective restoral facility which first generates a list of objects to be restored, which we edit to remove excluded objects, and then restores the database controlled by the list.
+
+## Restoral of attached files
+If the database is restored to an older version, there may be some attached files in the filesystem that now do not have associated ActiveRecord models. Rather than just delete these, they are moved to a directory called "orphan_files" so that they can be handled manually.
+
+## Logger
+A logger is used, with the log messages appended to in log/aws.log. Consider a rotation strategy for this file.
+
+## AWS credentials
+Stored in a .aws/credentials file in the home directory. (see [AWS sdk documentation](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html)) With contents:
+
+```markdown
+[default]
+account_id = your_account_id
+aws_access_key_id = your_access_key_id
+aws_secret_access_key = your_aws_secret_access_key
+
+```
+
+## Database access parameters
+The pg_restore command depends on the existence of a file called ~/.pgpass, containing access parameters for the database. (See [Postgres documentation](https://www.postgresql.org/docs/9.3/static/libpq-pgpass.html) for format details).

data/Rakefile

@@ -0,0 +1,13 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+RSpec::Core::RakeTask.module_eval do
+  def pattern
+    files = []
+    files << File.expand_path( 'spec/features/*_spec.rb', __FILE__ ).to_s
+    files << File.expand_path( 'spec/models/*_spec.rb', __FILE__ ).to_s
+  end
+end
+

data/app/assets/javascripts/glacier_on_rails/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/glacier_on_rails/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/glacier_on_rails/application_controller.rb

@@ -0,0 +1,2 @@
+class GlacierOnRails::ApplicationController < ApplicationController
+end

data/app/controllers/glacier_on_rails/application_data_backups_controller.rb

@@ -0,0 +1,43 @@
+class GlacierOnRails::ApplicationDataBackupsController < ApplicationController
+  before_action do
+    @application_data_backup = ApplicationDataBackup.find(params[:application_data_backup_id]) unless params[:application_data_backup_id].nil?
+  end
+
+  def create
+    @application_data_backup = ApplicationDataBackup.create
+    if @application_data_backup.persisted?
+      render :partial => 'glacier_on_rails/aws_archive_retrieval_jobs/application_data_backup',
+             :locals => {:application_data_backup => @application_data_backup}
+    else
+      render :js => "flash.error('failed to create backup');", :status => 500
+    end
+  end
+
+  def fetch
+    if @application_data_backup.fetch_archive
+      render :partial => 'glacier_on_rails/aws_archive_retrieval_jobs/application_data_backup',
+             :locals => {:application_data_backup => @application_data_backup}
+    else
+      render :partial => 'glacier_on_rails/aws_archive_retrieval_jobs/application_data_backup',
+             :locals => {:application_data_backup => @application_data_backup, :fetch_fail => true}
+    end
+  end
+
+  def restore
+    if @application_data_backup.restore
+      render :partial => 'glacier_on_rails/aws_archive_retrieval_jobs/application_data_backup',
+             :locals => {:application_data_backup => @application_data_backup}
+    else
+      render :js => "flash.error('Database restore failed');", :status => 500
+    end
+  end
+
+  def destroy
+    if @application_data_backup.destroy
+      head :ok
+    else
+      render :js => "flash.error('Deletion of archive failed for some reason');", :status => 500
+    end
+  end
+
+end

data/app/controllers/glacier_on_rails/aws_archive_retrieval_jobs_controller.rb

@@ -0,0 +1,7 @@
+class GlacierOnRails::AwsArchiveRetrievalJobsController < ApplicationController
+  def create
+    @application_data_backup = ApplicationDataBackup.find(params[:application_data_backup_id])
+    @application_data_backup.initiate_retrieval
+    render :partial => 'application_data_backup', :locals => {:application_data_backup => @application_data_backup}
+  end
+end

data/app/controllers/glacier_on_rails/aws_sns_subscriptions_controller.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+
+module GlacierOnRails
+  class AwsSnsSubscriptionsController < ApplicationController
+    class MessageWasNotAuthentic < StandardError; end
+
+    skip_before_action :verify_authenticity_token, :check_permissions, :only=>[:create]
+    def create
+      if request.headers["x-amz-sns-message-type"] == "SubscriptionConfirmation" # AWS sends a post to confirm subscription to notifications
+        subscribe_url = JSON.parse(request.raw_post)["SubscribeURL"]
+        raise MessageWasNotAuthentic unless subscribe_url =~ /^https.*amazonaws\.com\//
+        HTTParty.get subscribe_url # confirms subscription
+        AwsLog.info "AWS subscription confirmation request received"
+        head :ok
+      else # this is the notification from AWS Glacier that the retrieval job is completed
+        AwsLog.info "AWS notification received #{request.raw_post}"
+        # the notification that the retrieve_archive job has completed
+        message = JSON.parse(request.raw_post)["Message"]
+        json_message = JSON.parse(message)
+        job_id = json_message["JobId"]
+        glacier_archive = GlacierArchive.find_by(:archive_retrieval_job_id => job_id)
+        glacier_archive.update_attributes(:notification => json_message) if glacier_archive
+        head :ok
+      end
+    end
+  end
+end
+
+# Notification example, note that message is a string and must be parsed by JSON.parse
+# {
+#   "Type" : "Notification",
+#   "MessageId" : "b221d7d9-73c3-5e6d-9caf-8649cb198736",
+#   "TopicArn" : "arn:aws:sns:us-east-1:918359762546:retrieve_archive",
+#   "Message" : "{\"Action\":\"ArchiveRetrieval\",\"ArchiveId\":\"_vs0qWot3GIg7I3bsBomHTheu73qNkCW28_B1hKjXhvOMR5vh7rGQs4Ra_UEYdXCA1N6-F8aF-lN7SMqLl6pRyy7HX6mA0DPwhpXSPoOA7FixG1roXtx7O7QN8gFiz_GAyMR8OeqpQ\",\"ArchiveSHA256TreeHash\":\"0c47aee75a9587d83648fc1ea05d52646a67f704fbd23952c134d89776eccbe6\",\"ArchiveSizeInBytes\":285544,\"Completed\":true,\"CompletionDate\":\"2017-05-13T07:32:42.098Z\",\"CreationDate\":\"2017-05-13T03:40:19.264Z\",\"InventoryRetrievalParameters\":null,\"InventorySizeInBytes\":null,\"JobDescription\":\"put anything here\",\"JobId\":\"krCLWk6m7NJWppiy2SxdhP60f98PdrdaZBfhdDTZufrAkoh-ikrvb_NA0Q1vg2WcAhzZLL92kiwjOijUEDh0U7X09YQK\",\"RetrievalByteRange\":\"0-285543\",\"SHA256TreeHash\":\"0c47aee75a9587d83648fc1ea05d52646a67f704fbd23952c134d89776eccbe6\",\"SNSTopic\":\"arn:aws:sns:us-east-1:918359762546:retrieve_archive\",\"StatusCode\":\"Succeeded\",\"StatusMessage\":\"Succeeded\",\"Tier\":\"Standard\",\"VaultARN\":\"arn:aws:glacier:us-east-1:918359762546:vaults/demo\"}",
+#   "Timestamp" : "2017-05-13T07:32:42.229Z",
+#   "SignatureVersion" : "1",
+#   "Signature" : "i95PuF62vsfsrViAbgeHWP8vxZCzX+wMhUi4c8oveMkKT9PqmCXhQT6Jza86NCYMOOoxs8avUKE0mjuLlcrYqS6Iw3wLrx0P3Op/OJy2OQMelBp7nlWWvJpkRnsvY5EOpZF0auvsbsBLUrxgkoPAfP6/B3rO2BZubsu28fA0Qq4/Gzp2tM2U50NmggvRoD7Trt4usrgh8GCQ4iDr7Ce7jrxRglUgKA6/I4frlJG4l/bBwm6h5VzQgwO2xylPyaOSL2IIjiwcXeEwsYw8rGR2Qf+6/yLh4OiYxyp2X58MJSB4B7cenvziS+R95LC45LJrfmk3lK8x3L9xFPZPNjwzeA==",
+#   "SigningCertURL" : "https://sns.us-east-1.amazonaws.com/SimpleNotificationService-b95095beb82e8f6a046b3aafc7f4149a.pem",
+#   "UnsubscribeURL" : "https://sns.us-east-1.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:us-east-1:918359762546:retrieve_archive:fb8925ed-cc03-4f60-8301-27a4d5ad36d8"
+# }

data/app/helpers/glacier_on_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module GlacierOnRails
+  module ApplicationHelper
+  end
+end

data/app/models/application_data_backup.rb

@@ -0,0 +1,84 @@
+class ApplicationDataBackup < ActiveRecord::Base
+  has_one :glacier_db_archive, :dependent => :destroy
+  has_and_belongs_to_many :glacier_file_archives, association_foreign_key: 'glacier_file_archive_id', join_table: 'application_data_backups_glacier_file_archives'
+
+  after_destroy do |application_data_backup|
+    GlacierFileArchive.all.select{|gfa| gfa.application_data_backups.empty?}.each{|gfa| gfa.destroy}
+  end
+
+  before_create do |application_data_backup|
+    application_data_backup.create_archive
+    if application_data_backup.has_errors?
+      logger.debug "Error creating backup #{application_data_backup.errors.full_messages}"
+      throw :abort
+    end
+  end
+
+  def errors
+    unless components(:nil?).any?
+      components(:errors).map(&:full_messages).flatten.each do |message|
+        super.add(:base, message)
+      end
+    end
+    super
+  end
+
+  def create_archive
+    self.glacier_db_archive = GlacierDbArchive.create
+    # don't bother creating the file archives if the db archive fails
+    self.glacier_file_archives = GlacierFileArchive.all!  if glacier_db_archive.persisted?
+    # if any of them fail, we have errors
+  end
+
+  def initiate_retrieval
+    components(:initiate_retrieve_job)
+  end
+
+  def fetch_archive
+    components(:fetch_archive)
+    !has_errors?
+  end
+
+  def restore
+    rehome_orphans
+    components(:restore)
+  rescue GlacierArchive::RestoreFail
+    return false
+  end
+
+  def retrieval_status
+    # if any of the components has errors, just show status as 'available', an error message should be shown
+    return  'available' if has_errors?
+    # if components have different statuses, it's b/c they're not yet synchronized,
+    # so take the 'lowest' status, where rank (high to low) is exists, local, ready, pending, available
+    pick_lowest(components(:retrieval_status))
+  end
+
+  def has_errors?
+    errors.full_messages.length > 0
+  end
+
+  private
+  # files that were added since the backup-being-restored was created
+  # no longer have a reference in the database-being-restored.
+  # instead of just deleting them, move them to a different location.
+  # Any further disposition should be handled manually.
+  def rehome_orphans
+    files_to_be_restored = glacier_file_archives.map(&:filename)
+    existing_files = ApplicationFile.list
+    to_be_orphaned = existing_files - files_to_be_restored
+    to_be_orphaned.each do |file|
+      FileUtils.mv GlacierOnRails::Config.attached_files_directory.join(file), GlacierOnRails::Config.orphan_files_directory
+    end
+  end
+
+  def pick_lowest(statuses)
+    rank = ["available","pending","ready","local","exists"] # low to high
+    statuses.inject("exists"){|ref,stat| rank.index(stat) <= rank.index(ref) ? stat : ref }
+  end
+
+  def components(action)
+    db_result = glacier_db_archive.send(action)
+    glacier_file_archives.reject(&:exists_status?).collect { |archive| archive.send(action) } << db_result
+  end
+end

data/app/models/application_database/base_adapter.rb

@@ -0,0 +1,7 @@
+class ApplicationDatabase::BaseAdapter
+  attr_accessor :db_config
+
+  def initialize(db_config)
+    @db_config = db_config
+  end
+end

data/app/models/application_database/mysql_adapter.rb

@@ -0,0 +1,11 @@
+class ApplicationDatabase::MysqlAdapter < ApplicationDatabase::BaseAdapter
+
+  def contents
+    raise "Not yet implemented"
+  end
+
+  def restore(file)
+    raise "Not yet implemented"
+  end
+
+end