snapshotar 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9dce45f3945faf3abb06e4519cebb35fa7ea70a
-  data.tar.gz: d7b40e2306e8e32480ff02bf2071022e2a035531
+  metadata.gz: 6c9f9365f7e01ff0a219df26f250c42bc0bc2480
+  data.tar.gz: 0c3a2802ad5a5a379ff8b3088b55de2b1a710d56
 SHA512:
-  metadata.gz: dbf284de18e77b28bcf0f63b87ea6e76dd627983c3d29c02bdf1d00d084dc8791137bdbad27a673c7c2dd0aa9e0908778e231e6567e848d0429e1f5ffdd9109d
-  data.tar.gz: 0ff2656d88e83b4ed87863f5f063d10823c1ec99438cf13f57e383bcfeb9cd09b6b15baa08e5cf9f728ada348f6e82cba346faaba321c9b1b279ab837d10e1bd
+  metadata.gz: 21f902d6bc838fcbb758956486d851a38dd3d837fc9271098f5e97d08238a73c5ef17ef5cd304e1ebb364fb60c86f37673f47a4ad066b54ad12ead1b4d35cb6b
+  data.tar.gz: 49c80784904e76e46c0477c7f82c25ec4a14ecdb1cbf5e4cedd0eeec6e42ad6c64ff98a567490096a67a24a13d3cc9a4856c6ad94738728c323cd0da80f5271e

data/README.md

@@ -20,6 +20,12 @@ Or install it yourself as:
 
     $ gem install snapshotar
 
+Run install generator:
+
+    $ rails generate snapshotar:install
+
+Lookup *config/initializers/snapshotar.rb* and configure snapshotar.
+
 ## What snapshotar can...
 
 1. serializing your rails models to json
@@ -33,8 +39,7 @@ Or install it yourself as:
 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.
+- **fixtures/factories/fakers?** Because this requires coding. Don't spend time coding test data - it's boring.
 
 ## When to use snapshotar?
 
@@ -44,17 +49,67 @@ others fill up your app with sample data.
 ## Requirements
 
 - Ruby >= 1.9.3
-- Rails ?
+- tested with *Mongoid*, but *ActiveRecord* should work as well.
 
 ## Usage
 
-- one option for snapshotar is **rake**
+### rake
+
+    rake snapshotar:create                    # create a snapshots
+    rake snapshotar:delete                    # delete a snapshots
+    rake snapshotar:list                      # list available snapshots
+    rake snapshotar:load                      # load a snapshots
+
+### controller action
+
+You can also integrate snapshotar into your administration backend and let app
+users create snapshots. A sample controller is provided below
+
+*app/controllers/admin/snapshots_controller.rb*
+
+    class Admin::SnapshotsController < Admin::AdminController
+
+      def index
+        @snapshots = Snapshotar.list
+      end
+
+      def load
+        Mongoid.purge!
+        Snapshotar.load(params[:name])
+        redirect_to admin_snapshots_path
+      end
+
+      def new
+      end
+
+      def create
+        Snapshotar.create
+        redirect_to admin_snapshots_path
+      end
+
+      def delete
+        Snapshotar.delete(params[:name])
+        redirect_to admin_snapshots_path
+      end
+    end
 
-- you can also integrate snapshotar into your administration backend and let app
-users create snapshots.
 
 ## Configuration Options
 
+For **AWS S3**, you have to provide the following ENV variables provisioning your S3 bucket. For development environments look at this wonderful dot-env gem https://github.com/bkeepers/dotenv.
+
+    config.storage_type = :s3
+
+    AWS_ACCESS_KEY_ID=<your id>
+    AWS_SECRET_ACCESS_KEY=<your secret>
+    AWS_SNAPSHOTAR_BUCKET=<a bucket name>
+
+**Files**
+
+    config.storage_type = :file
+
+Snapshots are stored in the rails *tmp/* directory
+
 ## Testing
 This repository is under continuous integration testing on travis-ci.org.
 

data/lib/generators/snapshotar/install_generator.rb

@@ -0,0 +1,9 @@
+class Snapshotar::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  desc "This generator creates a snapshotar initializer file with default configuration at config/initializers"
+  def create_initializer_file
+    # initializer "snapshotar.rb", "puts 'this is the beginning'"
+    copy_file 'initializer.rb', File.join('config', 'initializers', 'snapshotar.rb')
+  end
+end

data/lib/generators/snapshotar/templates/initializer.rb

@@ -0,0 +1,22 @@
+# Snapshotar Gem
+# https://github.com/elchbenny/snapshotar
+# Benjamin Müller
+# 2014
+
+Snapshotar.configure do |config|
+
+
+  # Where to store your snapshots?
+  # :s3   -> for amazon s3 service
+  # :file -> local directory (default)
+  config.storage_type = :file
+
+  # Provide the models and their attributes to seralize in a nested array like this:
+  #    [[ModelName1, :attribute1, :attribute2,...],[ModelName2, :attribute1]]
+  #
+  # or even better to read like this
+  #    config.models << [Cinema, :id, :name, :coordinates, :cinema_more_images, :district_id]
+  #    config.models << [District, :id, :name]
+  config.models << []
+
+end

data/lib/snapshotar/version.rb

@@ -1,3 +1,3 @@
 module Snapshotar
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/snapshotar.gemspec

@@ -7,8 +7,8 @@ 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.email         = ["benjamin@berlab.io"]
+  spec.description   = %q{Make a snapshot of your rails database.}
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapshotar
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Benjamin Müller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,9 +122,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Make a snapshot of your rails database by serializing all objects.
+description: Make a snapshot of your rails database.
 email:
-- benjamin@boxar.de
+- benjamin@berlab.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -136,6 +136,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/snapshotar/install_generator.rb
+- lib/generators/snapshotar/templates/initializer.rb
 - lib/snapshotar.rb
 - lib/snapshotar/configuration.rb
 - lib/snapshotar/core.rb