verm-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a616e96483beae73fd10062005d641d30fb5352
-  data.tar.gz: 6b9fffb843d7d12a75c7cdb3658b193a740e5f32
+  metadata.gz: 2424da2dedcc8777ce4750ca0222bf5784cc7b32
+  data.tar.gz: 7cf07cf76cdc95d372a90e6fd7d13f3acb401ff3
 SHA512:
-  metadata.gz: 0aa23231f3b808815b44a89bf9cd81adf3e919affded5249c58ed6486aa41c4891f6d02427672c87b90e760047aed62b5033ec2dd8f1c9efe922c27d15997793
-  data.tar.gz: 9a333cbd52d2fc22b4e9389f0bb49f44592ffc26388bff151cb0795c9b54da62c89fd760f4556dbacb83ab57b0a3fedfdf974f1082bf75ffffe9bbd4ecf2ea4a
+  metadata.gz: fe7cd6811636171079bb872fa1fa392dbff10916271941a195af59199762e022c65dff4c1f42db6abc511ce4351a8e98a7669a440bc72e27831d4aaad74d5232
+  data.tar.gz: f0a02480c2bfcb26c92dd1d8fef7f90236dbbf6bab0fefae96126609fcf2066fc3babc02d4fb8d1b29ba83b045f412e269173aa317602652f90409ecb324e352

data/lib/verm/client.rb

@@ -2,6 +2,10 @@ require 'net/http'
 
 module Verm
   class Client
+    def self.incompressible_types
+      @incompressible_types ||= %w(image/jpeg image/png image/gif)
+    end
+
     attr_reader :http_client
 
     def initialize(hostname, port: 3404, timeout: 15)
@@ -11,7 +15,15 @@ module Verm
       @http_client.ssl_timeout = timeout
     end
 
-    def store(directory, io_or_data, content_type, encoding: nil)
+    def store(directory, io_or_data, content_type, encoding: nil, autocompress: true)
+      if %w(application/gzip application/x-gzip).include?(content_type) && encoding.nil?
+        raise ArgumentError, "Pass the real content-type and encoding: 'gzip' for gzipped uploads" # see 'File compression' in README.md
+      end
+
+      if autocompress && encoding.nil? && !self.class.incompressible_types.include?(content_type)
+        io_or_data, encoding = compress(io_or_data)
+      end
+
       directory = "/#{directory}" unless directory[0] == '/'
       request = Net::HTTP::Post.new(directory, 'Content-Type' => content_type)
       request['Content-Encoding'] = encoding.to_s if encoding
@@ -55,5 +67,21 @@ module Verm
         end
       end
     end
+
+  protected
+    def compress(io_or_data)
+      if io_or_data.respond_to?(:read) # we don't know how to implement compression for streaming because net/http wants readers not writers :(
+        return io_or_data
+      end
+
+      compressed = StringIO.new
+      compressed.set_encoding("BINARY")
+      gz = Zlib::GzipWriter.new(compressed)
+      gz.write(io_or_data)
+      gz.close
+      output = compressed.string
+      return output, "gzip" if output.bytesize < io_or_data.bytesize
+      io_or_data
+    end
   end
 end

data/lib/verm/version.rb

@@ -1,3 +1,3 @@
 module Verm
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/verm_test.rb

@@ -52,6 +52,20 @@ class TestVerm < Minitest::Test
     end
   end
 
+  def test_stores_compressed_files_if_given_compressible_but_uncompressed_content
+    content, type = "repetitive auto-compressible data"*10, "text/plain"
+    location = @client.store("/autocompress/", content, type)
+    assert_equal [content, type], @client.load(location) # will get auto-decompressed by ruby; proves just that the content was stored
+    refute_equal [content, type], @client.load(location, 'Accept-Encoding' => 'gzip') # setting an explicit Accept-Encoding turns off auto-decompress; the result would not be useful for apps since the encoding info is lost, but it proves that the content was not stored uncompressed and therefore was stored compressed
+  end
+
+  def test_stores_uncompressed_files_if_given_incompressible_uncompressed_content
+    content, type = "non-repetitive data", "text/plain"
+    location = @client.store("/autocompress/", content, type)
+    assert_equal [content, type], @client.load(location) # will get auto-decompressed by ruby; proves just that the content was stored
+    assert_equal [content, type], @client.load(location, 'Accept-Encoding' => 'gzip') # reverse of above; implies the content was stored uncompressed
+  end
+
   def test_loads_content_and_type
     content, type = "this is a test", "text/plain"
     assert_equal [content, type],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: verm-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Will Bryant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies: []
 description: |
   Adds one-line methods for storing files in Verm and retrieving them again.