remote_files 3.1.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a7fc219e4fd9f86ae482ca50d7eb34a002f191de97f932e01e44f1020846403
-  data.tar.gz: 530d0f1e212e46e3737334f3cf8a7f5bc8b6249176b59c774d272bf54fb8420a
+  metadata.gz: 2c031b3f95c929678e3ab56a3cc98c6aea47db1c294bfbd7b20a4390e90d06b6
+  data.tar.gz: c0665d4387cb9e15fca35e89387e6ac687b8b3c616d4d004892c6787596efe89
 SHA512:
-  metadata.gz: 6631796ee3ab3daeefb2bcb9807422ae616a65b32372d792ebd88441f6eb8a933a7c798e691ed2a81e4b48fdabf3e1f1766ed13c2d71df492333724b6067e4c3
-  data.tar.gz: 9b2e193ded1126905277c4a05475944c05c508e653dfda19e82de70236a9bc9488c20540f7955c8bf125a31fefd27dc46de4b7a4addf69d053de426e0c72d12c
+  metadata.gz: 646ff0467bf953702039d0240ca72fe56c0989d5639caa21778079ff4d5ae84014e85e9a191b48095b22dcafe70ba65819e52d771acb5da040fe418b6865b482
+  data.tar.gz: 45cdccb5afa27109216a3c4b56ba220de6410935dddcfde320b61a0642ffea945c3722f179c22b40fd8c8427098534fc93a06f7fc4042a8e2224fcf1d0707ad1

data/lib/remote_files/abstract_store.rb

@@ -22,6 +22,14 @@ module RemoteFiles
       raise "You need to implement #{self.class.name}:#directory_name"
     end
 
+    def files(prefix = '')
+      raise "You need to implement #{self.class.name} #files"
+    end
+
+    def copy_to_store!(file, target_store)
+      raise "You need to implement #{self.class.name} #copy_to_store!"
+    end
+
     def store!(file)
       raise "You need to implement #{self.class.name}#store!"
     end

data/lib/remote_files/file.rb

@@ -1,19 +1,21 @@
 module RemoteFiles
   class File
-    attr_reader :content, :content_type, :identifier, :stored_in, :configuration
+    attr_reader :content, :content_type, :identifier, :stored_in, :configuration, :populate_stored_in, :last_update_ts
 
     def initialize(identifier, options = {})
-      known_keys = [:identifier, :stored_in, :content_type, :configuration, :content]
+      known_keys = [:identifier, :stored_in, :content_type, :configuration, :content, :populate_stored_in, :last_update_ts]
       known_keys.each do |key|
         options[key] ||= options.delete(key.to_s)
       end
 
       @identifier    = identifier
-      @stored_in     = (options[:stored_in] || []).map(&:to_sym)
+      @stored_in     = (options[:stored_in] || []).map(&:to_sym) # TODO: Refactor so that there are two classes: `File` and `FileCopy`
       @content       = options.delete(:content)
+      @last_update_ts = options[:last_update_ts] || Time.now
       @content_type  = options[:content_type]
       @configuration = RemoteFiles::CONFIGURATIONS[(options[:configuration] || :default).to_sym]
       @logger        = options[:logger]
+      @populate_stored_in = options[:populate_stored_in]
       @options       = options
     end
 
@@ -34,7 +36,8 @@ module RemoteFiles
         :identifier    => identifier,
         :stored_in     => stored_in,
         :content_type  => content_type,
-        :configuration => configuration.name
+        :configuration => configuration.name,
+        :populate_stored_in => populate_stored_in
       )
     end
 
@@ -79,6 +82,8 @@ module RemoteFiles
           next unless file
           @content      = file.content
           @content_type = file.content_type
+          # :populate_stored_in is a boolean
+          @stored_in = file.stored_in if @populate_stored_in
           return true
         rescue Error => e
         end

data/lib/remote_files/file_store.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 require 'fileutils'
 
-# This is good for use in deveopment
+# This is good for use in development
 
 module RemoteFiles
   class FileStore < AbstractStore
@@ -13,6 +13,21 @@ module RemoteFiles
       end
     end
 
+    def files(prefix = '')
+      dir = directory + prefix
+
+      return [] unless dir.exist?
+
+      dir.children.reject do |child|
+        child.directory?
+      end.map do |child|
+        File.new(child.basename.to_s,
+                 :stored_in => [self],
+                 :last_update_ts => child.mtime
+        )
+      end
+    end
+
     def store!(file)
       file_name = directory + file.identifier
 
@@ -30,12 +45,19 @@ module RemoteFiles
       end
     end
 
+    def copy_to_store!(file, target_store)
+      FileUtils.cp(directory + file.identifier, target_store.directory + file.identifier)
+    end
+
     def retrieve!(identifier)
-      content = (directory + identifier).read
+      path = directory + identifier
+
+      content = (path).read
 
       RemoteFiles::File.new(identifier,
         :content      => content,
-        :stored_in    => [self]
+        :stored_in    => [self],
+        :last_update_ts => path.mtime
         # what about content-type? maybe use the mime-types gem?
       )
     rescue Errno::ENOENT

data/lib/remote_files/fog_store.rb

@@ -7,6 +7,7 @@ module RemoteFiles
 
     def store!(file)
       success = directory.files.create(store_options(file))
+      # TODO: Probably get the last modified time
 
       raise RemoteFiles::Error unless success
 
@@ -15,6 +16,10 @@ module RemoteFiles
       raise RemoteFiles::Error, $!.message, $!.backtrace
     end
 
+    def copy_to_store!(file, target_store)
+      target_store.connection.copy_object(directory_name, file.identifier, target_store.directory_name, file.identifier)
+    end
+
     def retrieve!(identifier)
       fog_file = directory.files.get(identifier)
 
@@ -23,7 +28,8 @@ module RemoteFiles
       File.new(identifier,
         :content      => fog_file.body,
         :content_type => fog_file.content_type,
-        :stored_in    => [self]
+        :stored_in    => [self],
+        :last_update_ts => fog_file.last_modified
       )
     rescue Fog::Errors::Error, Excon::Errors::Error
       raise RemoteFiles::Error, $!.message, $!.backtrace
@@ -53,28 +59,53 @@ module RemoteFiles
         raise RemoteFiles::Error, message
       end
 
-      connection.delete_object(directory.key, identifier)
+      connection.delete_object(directory_name, identifier)
     rescue Fog::Errors::NotFound, Excon::Errors::NotFound
       raise NotFoundError, $!.message, $!.backtrace
     end
 
     def connection
-      connection_options = options.dup
-      connection_options.delete(:directory)
-      connection_options.delete(:public)
-      @connection ||= Fog::Storage.new(connection_options)
+      opts = options.dup
+      opts.delete(:directory)
+      opts.delete(:public)
+      opts[:connection_options] ||= default_connection_options
+      @connection ||= Fog::Storage.new(opts)
     end
 
     def directory_name
       options[:directory]
     end
 
+    # TODO: Add file bodies if we think it's worth it
+    def files(prefix = '')
+      full_list = []
+
+      directory.files.all(:prefix => prefix).each do |file|
+        full_list.push(
+          File.new(file.identity,
+                 :content_type => file.content_type,
+                 :stored_in => [self],
+                 :last_update_ts => file.last_modified
+          )
+        )
+      end
+
+      full_list
+    end
+
     def directory
       @directory ||= lookup_directory || create_directory
     end
 
     protected
 
+    def default_connection_options
+      {
+        retry_limit: 0,
+        retry_interval: 0
+      }
+    end
+
     def aws_host
       case options[:region]
       when nil, 'us-east-1'

data/lib/remote_files/memory_store.rb

@@ -22,7 +22,11 @@ module RemoteFiles
 
     def store!(file)
       content = file.content.respond_to?(:read) ? file.content.read : file.content
-      data[file.identifier] = { :content => content, :content_type => file.content_type}
+      data[file.identifier] = { :content => content, :content_type => file.content_type, :last_update_ts => file.last_update_ts}
+    end
+
+    def copy_to_store!(file, target_store)
+      target_store.data[file.identifier] = data[file.identifier]
     end
 
     def retrieve!(identifier)
@@ -31,10 +35,23 @@ module RemoteFiles
       File.new(identifier,
         :content      => data[identifier][:content],
         :content_type => data[identifier][:content_type],
+        :last_update_ts => data[identifier][:last_update_ts],
         :stored_in    => [self]
       )
     end
 
+    def files(prefix = '')
+      @data.reject do |identifier|
+        !identifier.start_with? prefix
+      end.map do |identifier, data|
+        File.new(identifier,
+                 :content_type => data[:content_type],
+                 :last_update_ts => data[:last_update_ts],
+                 :stored_in => [self]
+        )
+      end
+    end
+
     def directory_name
       self.identifier.to_s
     end

data/lib/remote_files/version.rb

@@ -1,3 +1,3 @@
 module RemoteFiles
-  VERSION = '3.1.0'
+  VERSION = '3.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remote_files
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Mick Staugaard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -59,7 +59,7 @@ files:
 - lib/remote_files/version.rb
 homepage: https://github.com/zendesk/remote_files
 licenses:
-- Apache License Version 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -76,8 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: The purpose of the library is to implement a simple interface for uploading