ruby-manta 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b636e55491d14ec82b6c9d2bb7db81b3a27e8e2
-  data.tar.gz: 13359dea81e874109311d507442f20999d6e6311
+  metadata.gz: de7bfde003051167ceb812eeeee748fe405107ef
+  data.tar.gz: fa140f03d2becadedd4e1837a4cde82be2d5f937
 SHA512:
-  metadata.gz: 932ad21b320335849abdade93cc2d51fdc18a3ae3672d4ce42886c61a11a8c9b246ead95fecff4cef713f18ccfd014bfb7e30e0a8ade652ba68caf1bebcbd1ba
-  data.tar.gz: c66a383843d985524cacfa07a9660674de8dfd36cba20f0df13ef44b97b1bc0b7fb2ca069b6ab94a9c5d1ec41e32baa76310aeec38ec071cdecd4643126dfc91
+  metadata.gz: 997933f4865d0b6241fde0506319a08945cd15db8c4407e57b6609969f90d60e833d304873c37101e35f7852d58a578a0045cbc79eb16297ba72f3bb748a556b
+  data.tar.gz: 7aafc92abb2b0e3ac969bfe05242f2cca4ed99f6e8c8de50ecf7165ed451af068a357cb3b1a87bec5dbe8b422377cea150e87b6c62f6157d045e139535493bfc

data/README.md

@@ -169,9 +169,9 @@ supports it either.
 
 Changes in 2.0.0
 ----------------
- * MantaClient was moved into the namespace RubyManta::MantaClient. Compatibility
-   with the namespaceless 1.0.0 MantaClient was maintained, but it may not be
-   there in the future, so please update your application code.
+ * MantaClient was moved into the namespace RubyManta::MantaClient.
+   Compatibility with the namespaceless 1.0.0 MantaClient was maintained, but it
+   may not be there in the future, so please update your application code.
  * Subuser support was added to the client.
 
 
@@ -328,6 +328,26 @@ You can also pass in :origin to most object- and directory-related methods.
 
 
 
+Custom headers
+--------------
+
+Manta allows additional custom headers to be
+[added with an object](https://apidocs.joyent.com/manta/storage-reference.html#custom-headers).
+When the object is retrieved, the custom headers are returned as well.
+
+ruby-manta supports this, by adding any :m_* arguments as headers to an object.
+For example, to add an 'M-Foobar' header with an object:
+
+```ruby
+
+    client.put_object(/john/stor/passwd', 'weak', :m_foobar => 'baz')
+```
+
+A reminder when reading back headers (e.g. using get_object()) that header names
+are case-insensitive (see RFC 2616). 'M-Foobar' may return as 'm-foobar'.
+
+
+
 initialize(manta_host, user, priv_key, _options_)
 -------------------------------------------------
 

data/lib/ruby-manta/manta_client.rb

@@ -850,6 +850,13 @@ module RubyManta
 
 
 
+    # :m_some_header becomes "M-Some-Header"
+    def symbol_to_header(header_symbol)
+      header_symbol.to_s.split('_').map(&:capitalize).join('-')
+    end
+
+
+
     # Creates headers to be given to the HTTP client and sent to the Manta
     # service. The most important is the Authorization header, without which
     # none of this class would work.
@@ -889,6 +896,13 @@ module RubyManta
         headers.push([ 'Origin',  origin ])
       end
 
+      custom_headers = opts.keys.select { |key| key.to_s.start_with? 'm_' }
+      unless custom_headers.empty?
+        headers += custom_headers.map do |header_key|
+          [ symbol_to_header(header_key), opts[header_key] ]
+        end
+      end
+
       # add md5 hash when sending data
       data = opts[:data]
       if data

data/lib/ruby-manta/version.rb

@@ -1,3 +1,3 @@
 module RubyManta
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/test/unit/manta_client_test.rb

@@ -207,11 +207,13 @@ class TestMantaClient < Minitest::Test
 
     @@client.put_object(@@test_dir_path + '/obj1', 'bar-data',
                         :content_type     => 'application/wacky',
-                        :durability_level => 3)
+                        :durability_level => 3,
+                        :m_zip            => 'zap')
 
     result, headers = @@client.get_object(@@test_dir_path + '/obj1')
     assert_equal result, 'bar-data'
     assert_equal headers['Content-Type'], 'application/wacky'
+    assert_equal headers['m-zip'],        'zap'
 
     result, headers = @@client.get_object(@@test_dir_path + '/obj1', :head => true)
     assert_equal result, true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-manta
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Joyent