iostreams 1.0.0.beta5 → 1.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2115cf67139790d04fa7efa3df009d0a53a0f00e22d787e35a0f9410e92b4dda
-  data.tar.gz: b4af1f56d58b164dcee1dc36735ac9e9ec55413ead31feee37edb4c4abcca60f
+  metadata.gz: 167014d27ff57416cce79209be3025489a6312e208f3edccebb17f535dae9ae1
+  data.tar.gz: 55e1f44b9613010dc81f02bb03d92ee9ec32c2b9d49c4ec99657a9c072700fb7
 SHA512:
-  metadata.gz: 0f17f11c7a0e8704827340eeaac6b48823bb72a34eb6da0b9c15d3248596d9638e0fbe6dcdf424fb6e806582ccf9d05f20159b61ef9672a27f04c138775e3f2f
-  data.tar.gz: f5ca498422999b53d1789276b12ed24afef1b63a0f55bb0454d00b015898df7e936f58f91c68b012b6f2825e2ad2b44a311a2f4e82652d66c07cd4f5f729110e
+  metadata.gz: 7d82649bff9f6ff9c97e58caa499c0cf5ce5090553816a76155374d6123b91fb673426c4eddfed0e5da24fff89e77997e7064b87ec95bf7aac0f1bac7b6f9dd0
+  data.tar.gz: 97d1fa3c4e5771d4f7ad3e9d3b3580f5b4cadbc5d57838277e7e7fe21224d496b5978e788f54981143d579a39131b907c9b069881e8d2b200356d49b4b2362f8

data/lib/io_streams/paths/http.rb

@@ -38,6 +38,11 @@ module IOStreams
         super(uri.path)
       end
 
+      # Does not support relative file names since there is no concept of current working directory
+      def relative?
+        false
+      end
+
       def to_s
         url
       end

data/lib/io_streams/paths/s3.rb

@@ -15,6 +15,12 @@ module IOStreams
       #     s3://my-bucket-name/file_name.txt
       #     s3://my-bucket-name/some_path/file_name.csv
       #
+      # access_key_id: [String]
+      #   AWS Access Key Id to use to access this bucket.
+      #
+      # secret_access_key: [String]
+      #   AWS Secret Access Key Id to use to access this bucket.
+      #
       # Writer specific options:
       #
       # @option params [String] :acl
@@ -124,7 +130,7 @@ module IOStreams
       #
       # @option params [String] :object_lock_legal_hold_status
       #   The Legal Hold status that you want to apply to the specified object.
-      def initialize(url, client: nil, **args)
+      def initialize(url, client: nil, access_key_id: nil, secret_access_key: nil, **args)
         Utils.load_soft_dependency('aws-sdk-s3', 'AWS S3') unless defined?(::Aws::S3::Client)
 
         uri = URI.parse(url)
@@ -132,8 +138,14 @@ module IOStreams
 
         @bucket_name = uri.host
         key          = uri.path.sub(%r{\A/}, '')
-        @client      = client || ::Aws::S3::Client.new
-        @options     = args
+        if client.is_a?(Hash)
+          client[:access_key_id]     = access_key_id if access_key_id
+          client[:secret_access_key] = secret_access_key if secret_access_key
+          @client                    = ::Aws::S3::Client.new(client)
+        else
+          @client = client || ::Aws::S3::Client.new(access_key_id: access_key_id, secret_access_key: secret_access_key)
+        end
+        @options = args
 
         URI.decode_www_form(uri.query).each { |key, value| @options[key] = value } if uri.query
 
@@ -144,6 +156,11 @@ module IOStreams
         ::File.join("s3://", bucket_name, path)
       end
 
+      # Does not support relative file names since there is no concept of current working directory
+      def relative?
+        false
+      end
+
       def delete
         client.delete_object(bucket: bucket_name, key: path)
         self

data/lib/io_streams/paths/sftp.rb

@@ -73,6 +73,11 @@ module IOStreams
         super(uri.path)
       end
 
+      # Does not support relative file names since there is no concept of current working directory
+      def relative?
+        false
+      end
+
       def to_s
         url
       end
@@ -204,10 +209,10 @@ module IOStreams
           options = ssh_options.dup
           key     = options.delete('IdentityKey')
           # sftp requires that private key is only readable by the current user
-          File.open(file_name, 'wb', 0600) { |io| io.write(key) }
+          ::File.open(file_name, 'wb', 0600) { |io| io.write(key) }
 
           options['IdentityFile'] = file_name
-          yield sftp_args(ssh_options)
+          yield sftp_args(options)
         end
       end
 

data/lib/io_streams/version.rb

@@ -1,3 +1,3 @@
 module IOStreams
-  VERSION = "1.0.0.beta5".freeze
+  VERSION = "1.0.0.beta6".freeze
 end

data/lib/io_streams/zip/reader.rb

@@ -36,28 +36,24 @@ module IOStreams
         # Read from a zip file or stream, decompressing the contents as it is read
         # The input stream from the first file found in the zip file is passed
         # to the supplied block
-        def self.file(file_name, entry_file_name: nil)
-          Utils.load_soft_dependency('rubyzip', 'Zip', 'zip') unless defined?(::Zip)
+        def self.file(file_name, entry_file_name: nil, &block)
+          Utils.load_soft_dependency('rubyzip', 'Read Zip', 'zip') unless defined?(::Zip)
 
-          ::Zip::InputStream.open(file_name) do |zin|
-            get_entry(zin, entry_file_name) ||
-              raise(::Zip::EntryNameError, "File #{entry_file_name} not found within zip file.")
-            yield(zin)
+          ::Zip::File.open(file_name) do |zip_file|
+            if entry_file_name
+              zip_file.get_input_stream(entry_file_name, &block)
+            else
+              result = nil
+              # Return the first file
+              zip_file.each do |entry|
+                result = entry.get_input_stream(&block)
+                break
+              end
+              result
+            end
           end
         end
       end
-
-      def self.get_entry(zin, entry_file_name)
-        if entry_file_name.nil?
-          zin.get_next_entry
-          return true
-        end
-
-        while entry = zin.get_next_entry
-          return true if entry.name == entry_file_name
-        end
-        false
-      end
     end
   end
 end

data/lib/io_streams/zip/writer.rb

@@ -1,59 +1,29 @@
 module IOStreams
   module Zip
     class Writer < IOStreams::Writer
-      # Write a single file in Zip format to the supplied output file name
+      # Write a single file in Zip format to the supplied output stream
       #
       # Parameters
-      #   file_name [String]
-      #     Full path and filename for the output zip file.
+      #   output_stream [IO]
+      #     Output stream to write to
+      #
+      #   original_file_name [String]
+      #     Since this is a stream the original file name is used to create the entry_file_name if not supplied
       #
       #   entry_file_name: [String]
       #     Name of the file entry within the Zip file.
       #
       # The stream supplied to the block only responds to #write
-      #
-      # Example:
-      #   IOStreams::ZipWriter.open('myfile.zip', zip_file_name: 'myfile.txt') do |io_stream|
-      #     io_stream.write("hello world\n")
-      #     io_stream.write("and more\n")
-      #   end
-      #
-      # Notes:
-      # - Since Zip cannot write to streams, if a stream is supplied, a temp file
-      #   is automatically created under the covers
-      def self.file(file_name, original_file_name: file_name, zip_file_name: nil, entry_file_name: zip_file_name, &block)
+      def self.stream(output_stream, original_file_name: nil, zip_file_name: nil, entry_file_name: zip_file_name, &block)
         # Default the name of the file within the zip to the supplied file_name without the zip extension
-        if entry_file_name.nil? && (original_file_name =~ /\.(zip)\z/i)
+        if entry_file_name.nil? && original_file_name && (original_file_name =~ /\.(zip)\z/i)
           entry_file_name = original_file_name.to_s[0..-5]
         end
         entry_file_name ||= 'file'
 
-        write_file(file_name, entry_file_name, &block)
-      end
-
-      private
-
-      if defined?(JRuby)
-        def self.write_file(file_name, entry_file_name)
-          out  = Java::JavaIo::FileOutputStream.new(file_name)
-          zout = Java::JavaUtilZip::ZipOutputStream.new(out)
-          zout.put_next_entry(Java::JavaUtilZip::ZipEntry.new(entry_file_name))
-          io = zout.to_io
-          yield(io)
-        ensure
-          io&.close
-          out&.close
-        end
-      else
-        def self.write_file(file_name, entry_file_name)
-          Utils.load_soft_dependency('rubyzip', 'Zip', 'zip') unless defined?(::Zip)
+        Utils.load_soft_dependency('zip_tricks', 'Zip') unless defined?(ZipTricks::Streamer)
 
-          zos = ::Zip::OutputStream.new(file_name)
-          zos.put_next_entry(entry_file_name)
-          yield(zos)
-        ensure
-          zos&.close
-        end
+        ZipTricks::Streamer.open(output_stream) { |zip| zip.write_deflated_file(entry_file_name, &block) }
       end
     end
   end

data/test/paths/sftp_test.rb

@@ -13,6 +13,7 @@ module Paths
       let(:username) { ENV["SFTP_USERNAME"] }
       let(:password) { ENV["SFTP_PASSWORD"] }
       let(:ftp_dir) { ENV["SFTP_DIR"] || "iostreams_test" }
+      let(:identity_username) { ENV["SFTP_IDENTITY_USERNAME"] || username }
 
       let(:url) { File.join("sftp://", host_name, ftp_dir) }
 
@@ -71,7 +72,7 @@ module Paths
 
         describe 'use identity file instead of password' do
           let :root_path do
-            IOStreams::Paths::SFTP.new(url, username: username, ssh_options: {'IdentityFile' => ENV["SFTP_IDENTITY_FILE"]} )
+            IOStreams::Paths::SFTP.new(url, username: identity_username, ssh_options: {'IdentityFile' => ENV["SFTP_IDENTITY_FILE"]})
           end
 
           it 'writes' do
@@ -84,7 +85,7 @@ module Paths
         describe 'use identity key instead of password' do
           let :root_path do
             key = File.open(ENV["SFTP_IDENTITY_FILE"], 'rb', &:read)
-            IOStreams::Paths::SFTP.new(url, username: username, ssh_options: {'IdentityKey' => key})
+            IOStreams::Paths::SFTP.new(url, username: identity_username, ssh_options: {'IdentityKey' => key})
           end
 
           it 'writes' do

data/test/streams_test.rb

@@ -81,16 +81,16 @@ class StreamsTest < Minitest::Test
 
       it 'returns the reader' do
         string_io = StringIO.new
-        streams.stream(:zip)
+        streams.stream(:bz2)
         streams.reader(string_io) do |io|
-          assert io.is_a?(::Zip::InputStream), io
+          assert io.is_a?(RBzip2::FFI::Decompressor), io
         end
       end
 
       it 'returns the last reader' do
         string_io = StringIO.new
         streams.stream(:encode)
-        streams.stream(:zip)
+        streams.stream(:bz2)
         streams.reader(string_io) do |io|
           assert io.is_a?(IOStreams::Encode::Reader), io
         end
@@ -113,7 +113,7 @@ class StreamsTest < Minitest::Test
         string_io = StringIO.new
         streams.stream(:zip)
         streams.writer(string_io) do |io|
-          assert io.is_a?(::Zip::OutputStream), io
+          assert io.is_a?(ZipTricks::Streamer::Writable), io
         end
       end
 

data/test/zip_writer_test.rb

@@ -24,9 +24,7 @@ class ZipWriterTest < Minitest::Test
         IOStreams::Zip::Writer.file(file_name, entry_file_name: 'text.txt') do |io|
           io.write(decompressed)
         end
-        result = ::Zip::File.open(file_name) do |zip_file|
-          zip_file.first.get_input_stream.read
-        end
+        result = IOStreams::Zip::Reader.file(file_name, &:read)
         assert_equal decompressed, result
       end
 
@@ -36,14 +34,7 @@ class ZipWriterTest < Minitest::Test
           io.write(decompressed)
         end
         io     = StringIO.new(io_string.string)
-        result = nil
-        begin
-          zin = ::Zip::InputStream.new(io)
-          zin.get_next_entry
-          result = zin.read
-        ensure
-          zin.close if zin
-        end
+        result = IOStreams::Zip::Reader.stream(io, &:read)
         assert_equal decompressed, result
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.0.beta6
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2019-12-06 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: