rails-archiver 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc1b521101d84755190144096b2d1d97ac2e66e7
-  data.tar.gz: bcf461951a3da9969bcbf8ab3b32edb776f20e6f
+  metadata.gz: b0d76121c6ff0a8777277b47da964fc253096491
+  data.tar.gz: ee9dcbe2c0d1ec468ba44dc2e86b4f5f5b3c9f17
 SHA512:
-  metadata.gz: 5d286d61a14be69f8d076e3a9e3cb0ffcda2492df14cd79945ee0ef16e282b73ed699ab81865def9fdc96be52e32f4d578a72aadebf65fb304ae27a5bea1541e
-  data.tar.gz: 7b53b02be218bedaba1eaef692d9a0a4ac05fda3135d39fec9f628d449a9e590e881a6d9c1c620e2226bc0559ddd81b9f00fb770059427c09807dfcc6b8ec015
+  metadata.gz: eaf86068fff7d987a7098be77ec1cc25653525f973cc8abe4a97210a108feb2050d8f2ebba3bd8f35bae34c8f30c878aa1c3d7dc172ed2fd1e24d620001fb031
+  data.tar.gz: 14b088a8db577c782628458dadc86e40db6b551cb2d31a8bdff9391973469c1624dba5d82ba2c826dc42750a1ae946d2c9cc2a34a358fc83879c63d7f3ad32f1

data/lib/rails-archiver/archiver.rb

@@ -15,7 +15,7 @@ module RailsArchiver
       end
     end
 
-    attr_accessor :transport
+    attr_accessor :transport, :archive_location
 
     # Create a new Archiver with the given model.
     # @param model [ActiveRecord::Base] the model to archive or unarchive.
@@ -41,7 +41,7 @@ module RailsArchiver
       @hash = {}
       _visit_association(@model)
       @logger.info('Completed loading data')
-      @transport.store_archive(@hash)
+      @archive_location = @transport.store_archive(@hash)
       if @model.attribute_names.include?('archived')
         @model.update_attribute(:archived, true)
       end

data/lib/rails-archiver/transport/base.rb

@@ -5,7 +5,8 @@ module RailsArchiver
     class Base
 
       # @param model [ActiveRecord::Base] the model we will be working with.
-      def initialize(model, logger=nil)
+      # @param logger [Logger]
+      def initialize(model=nil, logger=nil)
         @model = model
         @options = {}
         @logger = logger || ::Logger.new(STDOUT)
@@ -27,8 +28,11 @@ module RailsArchiver
 
       # To be implemented by subclasses. Retrieve the archive that was previously
       # created.
+      # @param location [String] if given, the location of the archive (e.g.
+      # S3 key). Otherwise will be figured out from the existing model
+      # in the database.
       # @return [Hash] the retrieved hash.
-      def retrieve_archive
+      def retrieve_archive(location=nil)
         raise NotImplementedError
       end
 

data/lib/rails-archiver/transport/in_memory.rb

@@ -8,7 +8,7 @@ module RailsArchiver
         'some-key-here'
       end
 
-      def retrieve_archive
+      def retrieve_archive(location=nil)
         @options[:json]
       end
 

data/lib/rails-archiver/transport/s3.rb

@@ -1,5 +1,7 @@
 require 'aws-sdk'
 require 'securerandom'
+require 'tmpdir'
+
 # Transport that stores to S3. Uses an archived_s3_key attribute.
 module RailsArchiver
   module Transport
@@ -38,14 +40,26 @@ module RailsArchiver
           @logger.info("Uploading file to #{s3_key}")
           _save_archive_to_s3(s3_key, filename)
         end
+        if @model.respond_to?(:archived_s3_key)
+          @model.update_attribute(:archived_s3_key, s3_key)
+        end
         s3_key
-        @model.update_attribute(:archived_s3_key, s3_key)
       end
 
-      def retrieve_archive
+      # @param location [String]
+      def retrieve_archive(location=nil)
         Dir.mktmpdir do |dir|
-          filename = "#{dir}/#{@model.id}.json"
-          _get_archive_from_s3(@model.archived_s3_key, "#{filename}.gz")
+          s3_key = location
+          filename = nil
+          if @model
+            if @model.respond_to?(:archived_s3_key)
+              s3_key ||= @model.archived_s3_key
+            end
+            filename = "#{dir}/#{@model.id}.json"
+          else
+            filename = File.basename(s3_key)
+          end
+          _get_archive_from_s3(s3_key, "#{filename}.gz")
           @logger.info('Unzipping file')
           gunzip("#{filename}.gz")
           @logger.info('Parsing JSON')

data/lib/rails-archiver/unarchiver.rb

@@ -27,10 +27,13 @@ module RailsArchiver
     end
 
     # Unarchive a model.
-    def unarchive
+    # @param location [String] if given, uses the given location to unarchive.
+    # Otherwise uses the existing model in the database (e.g. attribute on the
+    # model) depending on the transport being used.
+    def unarchive(location=nil)
       @errors = []
       @logger.info('Downloading JSON file')
-      hash = @transport.retrieve_archive
+      hash = @transport.retrieve_archive(location)
       @logger.info("Loading #{@model.class.name}")
       load_classes(hash)
       @model.reload

data/rails-archiver.gemspec

@@ -1,18 +1,18 @@
 Gem::Specification.new do |s|
   s.name         = 'rails-archiver'
   s.require_paths = %w(. lib lib/rails-archiver)
-  s.version      = '0.1.2'
-  s.date         = '2018-05-03'
+  s.version      = '0.1.3'
+  s.date         = '2018-05-28'
   s.summary      = 'Fully archive a Rails model'
   s.description  = <<-EOF
-EOF
+  EOF
   s.authors      = ['Daniel Orner']
   s.email        = 'daniel.orner@wishabi.com'
-  s.files        = `git ls-files`.split($/)
+  s.files        = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.homepage     = 'https://github.com/dorner/rails-archiver'
-  s.license       = 'MIT'
+  s.license = 'MIT'
 
   s.add_dependency 'rails', '>= 3.0'
-  s.add_dependency 'aws-sdk', '~> 2.6'
+  s.add_development_dependency 'aws-sdk-s3', '~> 1.13'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-archiver
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Daniel Orner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :runtime
+        version: '1.13'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '1.13'
 description: ''
 email: daniel.orner@wishabi.com
 executables: []