activerecord_hoarder 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 476f76a46fae44bba761080f33f0c5073733de0e
-  data.tar.gz: 5040b1ce780046408e8ab065d18452e9ff6803b1
+  metadata.gz: 31a730ce894550da15cb55df86ac31187a694a33
+  data.tar.gz: d7787e32fe375777d46fced2d9c3d39163b32387
 SHA512:
-  metadata.gz: 195f314b03bf2f5f0e2f82da4a9c409b03ca4896d39e1bb055a8d3090d956b5ad929a69e0c1ab9015f6c5726233318062f364e2c392ccc0b58fcf662f7740370
-  data.tar.gz: ebd4a813bb3de31d7e61f962b4ff1b5098f71857dda2d016782c91227d22725de4c31dc45c99579de60b5e2f7f374cbde7fb2c6556f6fd6e5adf4bdc7abca75d
+  metadata.gz: 74fe678349717493ca3322595a17140351ec7f27e6e02b14f0914c2202ea8356960530b73c82a322139118c823909f223f03b0ea4153fe5348913d70411ea052
+  data.tar.gz: 5803619c244a353214f0bdacb9d91cdf27e768940694d2a0853227e75bd44bce5bb59b6919975445e1d395b00ab47cbc20576f6fb7a50ddd7bc97bc92d016d0a

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.1

data/.travis-setup.sh

@@ -0,0 +1,11 @@
+file_location=$(pwd)"/config/dbspec_rspec.yml"
+
+if [ -e file_location ]
+then
+  echo "$file_location found"
+else
+  echo "setting up database spec"
+  touch config/dbspec_rspec.yml
+  echo "adapter: sqlite3" >> config/dbspec_rspec.yml
+  echo "database: activerecord_hoarder_rspec.sqlite3" >> config/dbspec_rspec.yml
+fi

data/.travis.yml

@@ -1,5 +1,7 @@
+# travis
 sudo: false
 language: ruby
 rvm:
   - 2.4.1
 before_install: gem install bundler -v 1.15.4
+before_script: ./.travis-setup.sh

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-repo_name = "gem_batch_archiving"
+repo_name = "gem_activerecord_hoarder"
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 gem 'aws-sdk-s3', '~> 1'

data/README.md

@@ -1,9 +1,24 @@
 # Activerecord Hoarder
+[![Build Status](https://travis-ci.org/Scrimmage/gem_activerecord_hoarder.svg?branch=travis-bump)](https://travis-ci.org/Scrimmage/gem_activerecord_hoarder) [![Maintainability](https://api.codeclimate.com/v1/badges/7638f5eb8bdf48b29a30/maintainability)](https://codeclimate.com/github/Scrimmage/gem_activerecord_hoarder/maintainability)
 
 hoard records
 
 ## 1 Use
 
+### 1.0 configure
+before performing `1.2` and `1.3` the `ActiverecordHoarder::Storage` needs to be configured with
+ - `storage: :aws_s3` - only storage currently implemented
+ - `storage_options: {...}` with s3 credentials, connection details and default permissions
+
+#### Amazon S3 options
+- `access_key_id` *required* - amazon credential
+- `acl` *required* - amazon canned ACL (private, public-read, ...)*
+- `bucket` *required* - amazon connection detail
+- `bucket_sub_dir` *optional* - amazon key prefix
+- `region` *required* - amazon connection detail
+- `secret_access_key` *required* - amazon credential
+
+
 ### 1.1 make model a hoarder
 ```
 class ExampleModel < ActiveRecord::Base
@@ -21,7 +36,7 @@ will create S3 entries with keys: `<bucket_sub_dir>/<table_name = example_models
 ### 1.3 restoring records
 from console:
 ```
-ExampleModel.restore_date(Date.new(<Y>,<m>,<d>))
+ExampleModel.restore_archive_records(Date.new(<Y>,<m>,<d>))
 ```
 
 ## 2 Development
@@ -47,9 +62,9 @@ bundler exec bin/console
 
 #### bin/example
 Convenience functionality
-- `require_relative "bin/example/schema"` for creating an example table `examples`
-- `require_relative "bin/example/example"` for an example archivable model `Example`
-- `require_relative "bin/example/fixture"` for a factory method `create_examples(count, start: 0, deleted: true)` for creating examples
+- `require_relative "example/schema"` for creating an example table `examples`
+- `require_relative "example/example"` for an example archivable model `Example`
+- `require_relative "example/fixture"` for a factory method `create_examples(count, start: 0, deleted: true)` for creating examples
 
 ### 2.2 testing it
 

data/lib/activerecord_hoarder/batch_archiver.rb

@@ -6,7 +6,8 @@ class ::ActiverecordHoarder::BatchArchiver
 
   def archive_batch
     @record_collector.in_batches(delete_on_success: true) do |batch|
-      @archive_storage.store_data(batch)
+      success = @archive_storage.store_data(batch)
+      return if !success
     end
   end
 

data/lib/activerecord_hoarder/record_collector.rb

@@ -7,8 +7,7 @@ class ::ActiverecordHoarder::RecordCollector
 
   def in_batches(delete_on_success: false)
     while collect_batch
-      success = yield @batch
-      return if !success
+      yield @batch
       next if !delete_on_success
       destroy_current_records!
     end

data/lib/activerecord_hoarder/storage.rb

@@ -1,16 +1,6 @@
 class ::ActiverecordHoarder::Storage
   class_attribute :storage, :storage_options
 
-  def self.configure(storage:, storage_options:)
-    ::ActiverecordHoarder::Storages.is_valid_storage?(storage)
-
-    self.storage_options = storage_options
-    self.storage = storage
-    self
-  end
-
-  private
-
   def self.new(table_name, storage_override: nil, storage_options_override: {})
     self.check_configured
     storage_class = ::ActiverecordHoarder::Storages.retrieve(storage_override || storage)
@@ -19,6 +9,16 @@ class ::ActiverecordHoarder::Storage
 
   def self.check_configured
     raise ::ActiverecordHoarder::StorageError.new("storage needs to be configured") unless is_configured?
+
+  end
+
+  def self.configure(storage:, storage_options:)
+    ::ActiverecordHoarder::Storages.is_valid_storage?(storage)
+
+    self.storage_options = storage_options
+    self.storage = storage
+
+    self
   end
 
   def self.is_configured?

data/lib/activerecord_hoarder/version.rb

@@ -1,3 +1,3 @@
 module ActiverecordHoarder
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_hoarder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matthias Engh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-15 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -83,6 +83,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
+- ".travis-setup.sh"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt