snapshotar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b7518a6186d705c241f358e230cff6743b69b36
+  data.tar.gz: 319fcc1e61c96ad015507bb9b2da001c59c1ba51
+SHA512:
+  metadata.gz: a312f9567fd4a600df243ac3547d134fbac3a2a4c533f5a302a441bd7c07917dfa1e63cd36703b620b08f5a4411451c1ca41d23595ada61c43cb632996270963
+  data.tar.gz: e19decc5f4d9c7017d7b641053323d68958b5e4e3ae51652825f5bea8b188016f0d10d3d4a3eae06470ec03de94163c7e93690f15244759c0cdfe55c661222c3

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env
+uploads

data/.respec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - jruby-19mode # JRuby in 1.9 mode
+
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec
+services:
+  - mongodb
+env:
+  global:
+    - S3_ENABLED=false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Benjamin Müller
+
+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,79 @@
+[![Build Status](https://travis-ci.org/elchbenny/snapshotar.svg?branch=master)](https://travis-ci.org/elchbenny/snapshotar)
+[![Code Climate](https://codeclimate.com/github/elchbenny/snapshotar.png)](https://codeclimate.com/github/elchbenny/snapshotar)
+
+
+# Snapshotar
+
+Make a snapshot of your staging environment and pull back on your dev machine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'snapshotar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snapshotar
+
+## What snapshotar can...
+
+1. serializing your rails models to json
+2. handling *carrierwave* attachments
+3. storing serialized dataset locally or to amazon s3
+4. listing available snapshots
+5. deserialize snapshot and load back to database
+
+## Why snapshotar?
+
+instead of...
+
+- **database backup?** Because image attachments causing trouble!!
+- **fixtures/factories/fakers?** Because this requires coding. Let the
+others fill up your app with sample data.
+
+## When to use snapshotar?
+
+- For testing and development!!
+- definitely *NOT* for production backups
+
+## Requirements
+
+- Ruby >= 1.9.3
+- Rails ?
+
+## Usage
+
+- one option for snapshotar is **rake**
+
+- you can also integrate snapshotar into your administration backend and let app
+users create snapshots.
+
+## Configuration Options
+
+## Testing
+This repository is under continuous integration testing on travis-ci.org.
+
+Amazon S3 related functionalities are not tested in CI as an official account at
+amazon would be required. AWS S3 tests can be run locally by providing a *.env* file
+in the projects root directory with the following keys:
+
+    AWS_ACCESS_KEY_ID=<your id>
+    AWS_SECRET_ACCESS_KEY=<your secret>
+    AWS_SNAPSHOTAR_BUCKET=<a bucket name>
+
+    RACK_ENV=test
+
+    S3_ENABLED=true
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/snapshotar/configuration.rb

@@ -0,0 +1,25 @@
+module Snapshotar
+
+  ##
+  # Configuration Class
+  class Configuration
+
+    ##
+    # Where to store your snapshots?
+    # - +:s3+ for amazon s3 service
+    # - +:file+ local directory
+    attr_accessor :storage_type
+
+    ##
+    # Provide the models and their attributes to seralize like this:
+    #    [[ModelName1, :attribute1, :attribute2,...],[ModelName2, :attribute1]]
+    #
+    attr_accessor :models
+
+    def initialize #:nodoc:
+      @storage_type = :file
+      @models = []
+    end
+  end
+
+end

data/lib/snapshotar/core.rb

@@ -0,0 +1,103 @@
+require "snapshotar/storage/s3_storage"
+require "snapshotar/storage/file_storage"
+require "json"
+require "jbuilder"
+
+module Snapshotar
+
+  class Core
+
+    def initialize #:nodoc:
+      storage_class = Snapshotar::Storage::S3Storage if Snapshotar.configuration.storage_type == :s3
+      storage_class = Snapshotar::Storage::FileStorage if Snapshotar.configuration.storage_type == :file
+
+      @storage = storage_class.new
+    end
+
+    ##
+    # List all available snapshots.
+    #
+    # returns:: array of filenames
+    #
+    def list
+      @storage.index
+    end
+
+    ##
+    # Performs a snapshot
+    #
+    # Params::
+    #  +filename+:: filename to create or nil to let snapshotar create something
+    # like +snapshotar_dump_<timestamp>.json+
+    #
+    # returns:: +filename+
+    #
+    def export(filename = nil)
+      filename ||= "snapshotar_dump_#{Time.now.to_i}.json"
+
+      serialized = Jbuilder.encode do |json|
+        Snapshotar.configuration.models.each do |m|
+          model_name = m.first.name
+          json.set! model_name do
+            json.array! m.first.all do |itm|
+              m[1..-1].each do |attr|
+
+                next unless itm.respond_to?(attr.to_sym)
+
+                # replace uploads by their url
+                if itm.send(attr.to_sym).respond_to?(:url)
+                  json.set! "#{attr}_url".to_sym, itm.send(attr.to_sym).url
+                else
+                  json.set! attr.to_sym, itm[attr]
+                end
+              end
+            end
+          end
+        end
+      end
+
+      @storage.create(filename,serialized)
+
+      return filename
+    end
+
+    # Load a snapshot.
+    #
+    # Params::
+    #  +filename+:: name of the snapshot to load
+    #
+    def import(filename)
+      tree = JSON.load @storage.show(filename)
+
+      tree.each do |key,value|
+        clazz = key.constantize
+
+        value.each do |itm|
+          item_params = {}
+          itm.each do |itm_key,itm_value|
+            # handle url paths separatley
+            if itm_key.to_s.end_with?("_url")
+              orig_key = itm_key.to_s[0..-5].to_sym
+              item_params[orig_key] = File.open(itm_value)
+            else
+              item_params[itm_key] = itm_value
+            end
+          end
+          clazz.create(item_params)
+        end
+      end
+    end
+
+    ##
+    # delete a snapshot.
+    #
+    # Params::
+    #  +filename+:: name of the snapshot to delete
+    #
+    def delete(filename)
+
+      @storage.delete(filename)
+    end
+
+  end
+end

data/lib/snapshotar/storage/file_storage.rb

@@ -0,0 +1,67 @@
+module Snapshotar
+  module Storage
+
+    class FileStorage
+
+      ##
+      # Use this property to specify the local path where snapshots are stored.
+      # Default:: +tmp/+
+      #
+      attr_accessor :base_path
+
+      def initialize(path = nil) #:nodoc:
+        @base_path = path || "tmp"
+
+        # create tmp dir if it's not existent
+        unless File.directory?(@base_path)
+          FileUtils.mkdir_p(@base_path)
+        end
+      end
+
+      ##
+      # lists available snapshots in this storage.
+      #
+      # returns:: array of filenames
+      #
+      def index
+        Dir["#{@base_path}/*.json"].map{|p| File.basename(p)}
+      end
+
+      ##
+      # loads a snapshot specified by the given +filename+.
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to load
+      #
+      # returns:: still seralized json
+      #
+      def show(filename)
+        File.read File.join(@base_path, filename)
+      end
+
+      ##
+      # creates a snapshot specified by the given +filename+ with data provided
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to create
+      #  +serialized_tree+:: json serialized data
+      #
+      def create(filename,serialized_tree)
+        File.open(File.join(@base_path, filename),"w") do |f|
+          f.write(serialized_tree)
+        end
+      end
+
+      ##
+      # deletes a snapshot specified by the given +filename+.
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to delete
+      #
+      def delete(filename)
+        File.delete File.join(@base_path, filename)
+      end
+
+    end
+  end
+end

data/lib/snapshotar/storage/s3_storage.rb

@@ -0,0 +1,70 @@
+require "aws-sdk"
+
+module Snapshotar
+  module Storage
+
+    ##
+    # This snapshot storage type connects to amazon s3 via *aws-sdk gem*.
+    class S3Storage
+
+      def initialize #:nodoc:
+
+        raise ArgumentError, "You should set ENV['AWS_ACCESS_KEY_ID'] to a valid value" unless ENV['AWS_ACCESS_KEY_ID']
+        raise ArgumentError, "You should set ENV['AWS_SECRET_ACCESS_KEY'] to a valid value" unless ENV['AWS_SECRET_ACCESS_KEY']
+        raise ArgumentError, "You should set ENV['AWS_SNAPSHOTAR_BUCKET'] to a aws bucket name used only for snapshotting" unless ENV['AWS_SNAPSHOTAR_BUCKET']
+
+        p "Running S3 with key: #{ENV['AWS_ACCESS_KEY_ID']}, secret: #{ENV['AWS_SECRET_ACCESS_KEY']}, bucket: #{ENV['AWS_SNAPSHOTAR_BUCKET']}"
+
+        @s3 = AWS::S3.new(
+          access_key_id: ENV['AWS_ACCESS_KEY_ID'],
+          secret_access_key: ENV['AWS_SECRET_ACCESS_KEY'],
+          region: ENV['AWS_REGION'])
+
+        @bucket = @s3.buckets[ENV['AWS_SNAPSHOTAR_BUCKET']]
+      end
+
+      ##
+      # lists available snapshots in this storage.
+      #
+      # returns:: array of filenames
+      #
+      def index
+        @bucket.objects.map{|obj| obj.key}
+      end
+
+      ##
+      # loads a snapshot specified by the given +filename+.
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to load
+      #
+      # returns:: still seralized json
+      #
+      def show(filename)
+        @bucket.objects[filename]
+      end
+
+      ##
+      # creates a snapshot specified by the given +filename+ with data provided
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to create
+      #  +serialized_tree+:: json serialized data
+      #
+      def create(filename,serialized_tree)
+        @bucket.objects[filename].write(serialized_tree)
+      end
+
+      ##
+      # deletes a snapshot specified by the given +filename+.
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to delete
+      #
+      def delete(filename)
+        @bucket.objects[filename].delete
+      end
+
+    end
+  end
+end

data/lib/snapshotar/storage/storage_template.rb

@@ -0,0 +1,53 @@
+module Snapshotar
+  module Storage
+
+    class StorageTemplate
+
+      def initialize #:nodoc:
+      end
+
+      ##
+      # lists available snapshots in this storage.
+      #
+      # returns:: array of filenames
+      #
+      def index
+
+      end
+
+      ##
+      # loads a snapshot specified by the given +filename+.
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to load
+      #
+      # returns:: still seralized json
+      #
+      def show(filename)
+
+      end
+
+      ##
+      # creates a snapshot specified by the given +filename+ with data provided
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to create
+      #  +serialized_tree+:: json serialized data
+      #
+      def create(filename,serialized_tree)
+
+      end
+
+      ##
+      # deletes a snapshot specified by the given +filename+.
+      #
+      # Params::
+      #  +filename+:: name of the snapshot to delete
+      #
+      def delete(filename)
+
+      end
+
+    end
+  end
+end

data/lib/snapshotar/tasks.rb

@@ -0,0 +1,50 @@
+require "rake"
+
+namespace :snapshotar do
+
+  desc "list available snapshots"
+  task list: :environment do
+
+    file = ARGV.last
+    task file.to_sym do ; end
+
+    p "# Snapshotar: Listing available snapshots"
+    p Snapshotar.list
+  end
+
+  desc "create a snapshots"
+  task create: :environment do
+
+    file = ARGV.last
+    task file.to_sym do ; end
+
+    file = nil if file.downcase == "snapshotar:create"
+
+    p "# Snapshotar: Creating snapshots #{file}"
+    p Snapshotar.create(file)
+  end
+
+  desc "load a snapshots"
+  task load: :environment do
+
+    file = ARGV.last
+    task file.to_sym do ; end
+
+    file = nil if file.downcase == "snapshotar:load"
+
+    p "# Snapshotar: Loading snapshot #{file}"
+    p Snapshotar.load(file)
+  end
+
+  desc "delete a snapshots"
+  task delete: :environment do
+
+    file = ARGV.last
+    task file.to_sym do ; end
+
+    file = nil if file.downcase == "snapshotar:delete"
+
+    p "# Snapshotar: Listing deleting snapshot #{file}"
+    p Snapshotar.delete(file)
+  end
+end

data/lib/snapshotar/version.rb

@@ -0,0 +1,3 @@
+module Snapshotar
+  VERSION = "0.0.1"
+end

data/lib/snapshotar.rb

@@ -0,0 +1,65 @@
+require "snapshotar/configuration"
+require "snapshotar/version"
+require "snapshotar/core"
+require "snapshotar/tasks"
+
+##
+# Make a snapshot of your staging environment and pull back on your dev machine.
+
+module Snapshotar
+
+  class << self
+
+    ##
+    # Configuration object. Create a *snapshotar.rb* initializer under
+    # config/initializers and add your configuation inside:
+    #
+    #    Snapshotar.configure do |config|
+    #      config.storage_type = :file # :s3
+    #
+    #      config.models << [Event, :name, :date]
+    #      config.models << [Artist, :name]
+    #    end
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.core
+    @core ||= Core.new
+  end
+
+  ##
+  # List available snapshots
+  #
+  def self.list
+    self.core.list
+  end
+
+  ##
+  # Create a snapshot
+  #
+  def self.create(name = nil)
+    self.core.export(name)
+  end
+
+  ##
+  # Load a snapshot
+  #
+  def self.load(name)
+    self.core.import(name)
+  end
+
+  ##
+  # Delete a snapshot
+  #
+  def self.delete(name)
+    self.core.delete(name)
+  end
+end

data/snapshotar.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snapshotar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "snapshotar"
+  spec.version       = Snapshotar::VERSION
+  spec.authors       = ["Benjamin Müller"]
+  spec.email         = ["benjamin@boxar.de"]
+  spec.description   = %q{Make a snapshot of your rails database by serializing all objects.}
+  spec.summary       = %q{In contrast to a database backup, snapshotAR is able to manage image references made with paperclip or carrierwave correctly. You are able to save your entire application or only parts of it and e.g. seed your test environments. }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib","tasks"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency 'mongoid', '~> 4.0.0'
+  spec.add_development_dependency 'carrierwave-mongoid'
+
+  spec.add_dependency 'aws-sdk', '~> 1.0'
+  spec.add_dependency 'jbuilder'
+end

data/spec/carrierwave_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Snapshotar::Storage::FileStorage do
+
+  context "local file storage" do
+
+    before(:all) do
+      Mongoid.purge!
+
+      # setup configuration
+      Snapshotar.configure do |config|
+
+        config.storage_type = :file
+
+        # serialization
+        config.models << [Artist, :name, :avatar]
+      end
+
+      # create models with images attached
+      artist = Artist.create({name: "Artist 3"})
+      artist.avatar.store!(File.open("snapshotar.png"))
+      artist.save
+
+      @snapshotar = Snapshotar::Core.new
+    end
+
+    after(:all) do
+      # clean up files
+      FileUtils.rm_rf(Dir["tmp"])
+
+      Mongoid.purge!
+    end
+
+    it "should create image models" do
+      expect(Artist.count).to eq 1
+      p Artist.first.avatar.path
+    end
+
+    it "should export successfully" do
+      filename = @snapshotar.export
+
+      expect(@snapshotar.list).to include(filename)
+
+      # clean up
+      @snapshotar.delete(filename)
+    end
+
+    it "should reimport with images" do
+      # export sample
+      filename = @snapshotar.export
+
+      # clear db
+      Mongoid.purge!
+
+      expect(Artist.count).to eq 0
+
+      # # reimport
+      @snapshotar.import(filename)
+
+      expect(Artist.count).to eq 1
+      expect(Artist.first.avatar.path).not_to be_nil
+
+      # clean up
+      @snapshotar.delete(filename)
+    end
+  end
+end

data/spec/config/mongoid.yml

@@ -0,0 +1,14 @@
+test:
+  sessions:
+    default:
+      database: snapshotar_test
+      hosts:
+        -  <%= ENV['WERCKER_MONGODB_HOST'] || 'localhost:27017' %>
+      options:
+        # consistency: :strong
+        # In the test environment we lower the retries and retry interval to
+        # low amounts for fast failures.
+        max_retries: 1
+        retry_interval: 0
+  options:
+    raise_not_found_error: false

data/spec/config_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+#:nodoc:
+describe Snapshotar::Core do
+
+  context "listing snapshots" do
+
+    before(:all) do
+      Snapshotar.configure do |config|
+        # lets use default values
+        config.storage_type = :file
+        config.models = []
+      end
+    end
+
+    it "should load default config" do
+      expect(Snapshotar.configuration).not_to be_nil
+
+      expect(Snapshotar.configuration.storage_type).to eq :file
+      expect(Snapshotar.configuration.models).to be_empty
+    end
+
+  end
+end

data/spec/core_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+require 'jbuilder'
+
+#:nodoc:
+describe Snapshotar::Core do
+
+  context "listing snapshots" do
+
+    before(:all) do
+
+      # clear db
+      Mongoid.purge!
+
+      # setup configuration
+      Snapshotar.configure do |config|
+
+        config.storage_type = :file
+
+        # serialization
+        config.models << [Event, :name, :date]
+        config.models << [Artist, :name]
+
+      end
+
+      # create sample data
+      Event.create({name: "Event 1", date: Date.new})
+      Event.create({name: "Event 2", date: Date.new})
+
+      Artist.create({name: "Artist 1"})
+      Artist.create({name: "Artist 2"})
+    end
+
+    after(:all) do
+      # clean up
+      FileUtils.rm_rf(Dir["tmp"])
+      Mongoid.purge!
+    end
+
+    it "should list snapshots" do
+      expect(Snapshotar.list).to be_empty
+    end
+
+    it "should have one Event" do
+      expect(Event.count).to eq 2
+      expect(Artist.count).to eq 2
+    end
+
+    it "should correctly read config models" do
+
+      serialized = Jbuilder.encode do |json|
+        Snapshotar.configuration.models.each do |m|
+          model_name = m.first.name
+          json.set! model_name do
+            json.array! m.first.all, *m[1..-1]
+          end
+        end
+      end
+
+      # p "serialized: #{serialized}"
+    end
+
+    it "should export models" do
+      filename = Snapshotar.create
+      expect(Snapshotar.list).to include(filename)
+
+      # clean up
+      Snapshotar.delete(filename)
+    end
+
+    it "should import models" do
+      # export sample
+      filename = Snapshotar.create
+
+      # clear db
+      Mongoid.purge!
+
+      expect(Event.count).to eq 0
+      expect(Artist.count).to eq 0
+
+      # reimport
+      Snapshotar.load(filename)
+
+      expect(Event.count).to eq 2
+      expect(Artist.count).to eq 2
+
+      # clean up
+      Snapshotar.delete(filename)
+    end
+  end
+end

data/spec/file_storage_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'json'
+
+describe Snapshotar::Storage::FileStorage do
+
+  TMP_DIR = "tmp"
+
+  context "local file storage" do
+
+    before(:all) do
+      @fileStorage = described_class.new(TMP_DIR)
+
+      # write a test file
+      f = File.open(File.join(TMP_DIR,"test.json"), "w+")
+      f.close
+
+    end
+
+    after(:all) do
+
+      # clean up
+      File.delete(File.join(TMP_DIR,"test.json"))
+    end
+
+    it "should initialize correctly" do
+    end
+
+    it "should list objects" do
+
+      expect(@fileStorage.index).not_to be_empty
+      expect(@fileStorage.index.count).to eq 1
+    end
+
+    it "should show one element" do
+
+      expect(@fileStorage.show(@fileStorage.index.first)).not_to be_nil
+    end
+
+    it "should create an element" do
+
+      @fileStorage.create("zz_testdump.json",{"test" => "this is a test object"}.to_json)
+
+      expect(JSON.load(@fileStorage.show("zz_testdump.json"))).to have_key("test")
+
+      @fileStorage.delete("zz_testdump.json")
+    end
+
+  end
+end

data/spec/models/artist.rb

@@ -0,0 +1,10 @@
+# this is a sample model for testing purpose
+require_relative './image_uploader'
+
+class Artist #:nodoc:
+   include Mongoid::Document
+
+   mount_uploader :avatar, ImageUploader
+
+   field :name, type: String
+end

data/spec/models/event.rb

@@ -0,0 +1,8 @@
+# this is a sample model for testing purpose
+
+class Event #:nodoc:
+   include Mongoid::Document
+
+   field :name, type: String
+   field :date, type: Date
+end

data/spec/models/image_uploader.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'carrierwave/mongoid'
+
+class ImageUploader < CarrierWave::Uploader::Base
+
+  # Include RMagick or MiniMagick support:
+  # include CarrierWave::RMagick
+  # include CarrierWave::MiniMagick
+
+  # Choose what kind of storage to use for this uploader:
+  # storage :fog
+  storage = :file
+  enable_processing = false
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "tmp/uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+end

data/spec/s3_storage_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+#:nodoc:
+describe Snapshotar::Storage::S3Storage do
+
+  context "setup s3 connection", require_s3: true do
+
+    before(:all) do
+      @s3Storage = described_class.new
+    end
+
+    it "should initialize correctly" do
+    end
+
+    it "should list objects" do
+      expect(@s3Storage.index).not_to be_empty
+    end
+
+    it "should show one element" do
+      expect(@s3Storage.show(@s3Storage.index.first)).not_to be_nil
+    end
+
+    it "should create an element" do
+      @s3Storage.create("zz_testdump.json",{"test" => "this is a test object"}.to_json)
+
+      expect(JSON.load(@s3Storage.show(@s3Storage.index.last))).to have_key("test")
+
+      @s3Storage.delete("zz_testdump.json")
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'dotenv'
+Dotenv.load
+
+require 'snapshotar'
+require 'mongoid'
+
+Mongoid.load!('spec/config/mongoid.yml')
+
+require 'carrierwave/mongoid'
+
+CarrierWave.configure do |config|
+  config.root = Dir.pwd
+  config.asset_host = Dir.pwd
+end
+
+require 'models/event'
+require 'models/artist'
+
+
+RSpec.configure do |config|
+
+  config.tty = true
+
+  if ENV['S3_ENABLED']=="false"
+    p "Skipping S3 Tests"
+    config.filter_run_excluding require_s3: true
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: snapshotar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benjamin Müller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: carrierwave-mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make a snapshot of your rails database by serializing all objects.
+email:
+- benjamin@boxar.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .respec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/snapshotar.rb
+- lib/snapshotar/configuration.rb
+- lib/snapshotar/core.rb
+- lib/snapshotar/storage/file_storage.rb
+- lib/snapshotar/storage/s3_storage.rb
+- lib/snapshotar/storage/storage_template.rb
+- lib/snapshotar/tasks.rb
+- lib/snapshotar/version.rb
+- snapshotar.gemspec
+- snapshotar.png
+- spec/carrierwave_spec.rb
+- spec/config/mongoid.yml
+- spec/config_spec.rb
+- spec/core_spec.rb
+- spec/file_storage_spec.rb
+- spec/models/artist.rb
+- spec/models/event.rb
+- spec/models/image_uploader.rb
+- spec/s3_storage_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- tasks
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: In contrast to a database backup, snapshotAR is able to manage image references
+  made with paperclip or carrierwave correctly. You are able to save your entire application
+  or only parts of it and e.g. seed your test environments.
+test_files:
+- spec/carrierwave_spec.rb
+- spec/config/mongoid.yml
+- spec/config_spec.rb
+- spec/core_spec.rb
+- spec/file_storage_spec.rb
+- spec/models/artist.rb
+- spec/models/event.rb
+- spec/models/image_uploader.rb
+- spec/s3_storage_spec.rb
+- spec/spec_helper.rb