orchestrate 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e012cb7bc45936de2be4211e167acee8a8908b8
-  data.tar.gz: aa2439edb8a6594826e8e1e892d86e4d3dd9df34
+  metadata.gz: 155ad76859df4168e1f6c4bccb31aa3653c8d818
+  data.tar.gz: ff250dcd5c8fee7d94517aee3cc4ca3779111b08
 SHA512:
-  metadata.gz: 4b1088cdddc122bbfaef376f5e577155cecae4d2cfa5e658a1a7ddf593ea0253cf29929054da79dfa63ab2bfb3a1f410759043863a884fc7aeb2784ff808ff15
-  data.tar.gz: e4c960bd4754ae8bcb1dc08b79e903016c84b3f7583845f520c6b9cb458fc2b7c37336e2c52d85eda04d1aaa8c652b20c4aa7594c63c1f3abe9ae9d94a6b3f2a
+  metadata.gz: 29dc0b21580643d4dc2f064a0db2794be8d2d91abadb1ebc7f81c40359801aafe7fd6991de2c0739bd4b7a19449038c747940b4a3f1e419b7c2104c4ce386fb3
+  data.tar.gz: 6bdadb28536cefb2b8969e4e98f7ea2c8da1f13b1344395fb7407508c51ee863d70bc2cecf3129897942ab5fdf51be0324f3a743e9f3ebfe65770ae2e928705b

data/README.md

@@ -104,6 +104,12 @@ end
 
 ## Release Notes
 
+- June 24, 2014: release 0.6.2
+  - Fix #48 to remove trailing -gzip from Etag header for ref value.
+  - Custom #to_s and #inspect methods for Client, Response classes.
+  - Implement `If-Match` header for Client#purge
+  - Implement Client#post for auto-generated keys endpoint
+
 - June 17, 2014: release 0.6.1
   - Fix #43 for If-None-Match on Client#put
   - Fix #46 for Client#ping

data/lib/orchestrate/api/response.rb

@@ -40,6 +40,12 @@ module Orchestrate::API
       @request_time = Time.parse(headers['Date'])
     end
 
+    # @!visibility private
+    def to_s
+      "#<#{self.class.name} status=#{status} request_id=#{request_id}>"
+    end
+    alias :inspect :to_s
+
   end
 
   # A generic response for a single entity (K/V, Ref, Event)
@@ -55,8 +61,9 @@ module Orchestrate::API
     def initialize(faraday_response, client)
       super(faraday_response, client)
       @location = headers['Content-Location'] || headers['Location']
-      @ref = headers.fetch('Etag','').gsub('"','')
+      @ref = headers.fetch('Etag','').gsub('"','').sub(/-gzip$/,'')
     end
+
   end
 
   # A generic response for a collection of entities (K/V, Refs, Events, Search)

data/lib/orchestrate/client.rb

@@ -35,6 +35,12 @@ module Orchestrate
       end
     end
 
+    # @!visibility private
+    def to_s
+      "#<Orchestrate::Client api_key=#{api_key[0..7]}... >"
+    end
+    alias :inspect :to_s
+
     # Tests authentication with Orchestrate.
     # @return Orchestrate::API::Response
     # @raise Orchestrate::API::Unauthorized if the client could not authenticate.
@@ -105,6 +111,15 @@ module Orchestrate
       send_request :get, [collection, key, :refs], { query: options, response: API::CollectionResponse }
     end
 
+    # [Creates a value at an auto-generated
+    # key](https://orchestrate.io/docs/api/?shell#key/value/post-\(create-&-generate-key\)).
+    # @param collection [#to_s] The name of the collection.
+    # @param body [#to_json] The value to store.
+    # @return Orchestrate::API::ItemResponse
+    def post(collection, body)
+      send_request :post, [collection], { body: body, response: API::ItemResponse }
+    end
+
     # [Updates the value associated with
     # a key](http://orchestrate.io/docs/api/#key/value/put-\(create/update\)).
     # If the key does not currently have a value, will create the value.
@@ -159,10 +174,12 @@ module Orchestrate
     # key](http://orchestrate.io/docs/api/#key/value/delete11).
     # @param collection [#to_s] The name of the collection.
     # @param key [#to_s] The name of the key.
+    # @param ref [#to_s] If specified, purges the ref only if the current value's ref matches.
     # @return Orchestrate::API::Response
-    # @todo take an optional ref for If-Match
-    def purge(collection, key)
-      send_request :delete, [collection, key], { query: { purge: true } }
+    def purge(collection, key, ref=nil)
+      headers = {}
+      headers['If-Match'] = API::Helpers.format_ref(ref) if ref
+      send_request :delete, [collection, key], { query: { purge: true }, headers: headers }
     end
 
     # [List the KeyValue items in a collection](http://orchestrate.io/docs/api/#key/value/list).

data/lib/orchestrate/version.rb

@@ -1,3 +1,3 @@
 module Orchestrate
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/test/orchestrate/api/key_value_test.rb

@@ -16,7 +16,7 @@ class KeyValueTest < MiniTest::Unit::TestCase
       assert_accepts_json env
       headers = {
         'Content-Location' => ref_url,
-        'ETag' => "\"#{ref}\"",
+        'ETag' => "\"#{ref}-gzip\"",
       }.merge(chunked_encoding_header)
       [ 200, response_headers(headers), body.to_json]
     end
@@ -25,7 +25,7 @@ class KeyValueTest < MiniTest::Unit::TestCase
     assert_equal 200, response.status
     assert_equal body, response.body
 
-    assert_equal "\"#{ref}\"", response.headers['Etag']
+    assert_equal "\"#{ref}-gzip\"", response.headers['Etag']
     assert_equal ref_url, response.headers['Content-Location']
 
     assert_equal ref_url, response.location
@@ -46,6 +46,23 @@ class KeyValueTest < MiniTest::Unit::TestCase
     end
   end
 
+  def test_posts_key_value
+    body = {"foo" => "bar"}
+    ref = "12345"
+    key = "567890ac"
+    @stubs.post("/v0/#{@collection}") do |env|
+      assert_authorization @basic_auth, env
+      assert_header 'Content-Type', 'application/json', env
+      assert_equal body.to_json, env.body
+      headers = { "Location" => "/v0/#{@collection}/#{key}/refs/#{ref}", "Etag" => "\"#{ref}\"" }
+      [ 201, response_headers(headers), '' ]
+    end
+    response = @client.post(@collection, body)
+    assert_equal 201, response.status
+    assert_equal ref, response.ref
+    assert_equal "/v0/#{@collection}/#{key}/refs/#{ref}", response.location
+  end
+
   def test_puts_key_value_without_ref
     body={"foo" => "bar"}
     ref = "12345"
@@ -169,6 +186,18 @@ class KeyValueTest < MiniTest::Unit::TestCase
     assert_equal response.headers['X-Orchestrate-Req-Id'], response.request_id
   end
 
+  def test_delete_key_value_with_purge_and_condition
+    ref = "12345"
+    @stubs.delete("/v0/#{@collection}/#{@key}") do |env|
+      assert_authorization @basic_auth, env
+      assert_equal "true", env.params["purge"]
+      assert_header 'If-Match', "\"#{ref}\"", env
+      [ 204, response_headers, '' ]
+    end
+    response = @client.purge(@collection, @key, ref)
+    assert_equal 204, response.status
+  end
+
   def test_gets_ref
     body = {"key" => "value"}
     ref = '123456'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Matthew Lyon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday