fix(state): Updates State#get to return a Hash instead of an Array (#76)

* fix(state)!: Updates the State#get call to return a hash instead of array

* docs(state): Adds documentation for return value of #set

Author: bougyman

Readme.adoc

@@ -126,6 +126,30 @@ TIP: Multiple topics can be subscribed to simultaneously by passing an array of
 
 Implementation of {state-block}
 
+==== Set state key(s)
+
+[source,ruby]
+----
+require 'dapr/client/state' <1>
+desired_state = { key1: 'value1', key2: { nested: 'value2' }.to_json } <2>
+Rubyists::Dapr::Client::State.set(desired_state) <3>
+----
+<1> Require the state client.
+<2> Define the desired state. This must be a hash with simple keys, and the values must be strings (thus the #to_json)
+<3> Set the state. This will overwrite any existing state with the same key(s) (and update the etag of any updated keys)
+
+==== Get state key(s)
+
+[source,ruby]
+----
+require 'dapr/client/state' <1>
+states = Rubyists::Dapr::Client::State.get('key1', 'key2') <2>
+puts states['key1'].data <3>
+----
+<1> Require the state client.
+<2> Get the state for the specified key(s). This will return a hash whose values respond to #data.
+<3> Access the data of the state for the `key1` key.
+
 === Actors
 
 Implementation of {actors-block}
@@ -178,7 +202,7 @@ Releases are handled by release-please in github actions.
 
 == Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rubyists/dapr.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubyists/dapr-ruby-client.
 
 === Conventional Commits
 

coverage/coverage.json

@@ -1 +1 @@
-{"timestamp":1729718516,"command_name":"Unit Tests","files":[{"filename":"/home/bougyman/rubyists/dapr/lib/dapr.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,null,null,1,1,7,null,null,null,1,1,1,1,1,null,null]},"covered_strength":1.6,"covered_lines":10,"lines_of_code":10},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,1,1,1,null,1,1,null,1,1,1,1,1,1,null,1,4,null,1,1,null,null,1,11,null,null,1,1,null,null,1,14,null,null,null,1,1,null,1,5,null,null,1,1,1,1,null,1,null,null,1,1,null,null,null,null,null]},"covered_strength":1.8823529411764706,"covered_lines":34,"lines_of_code":34},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client/configuration.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,null,1,1,1,null,1,null,1,1,null,null,1,null,null,1,null,1,1,null,1,1,1,null,null,null,null,null,null,null,1,1,1,1,null,null,1,1,1,null,null,null,null,null]},"covered_strength":1.0,"covered_lines":21,"lines_of_code":21},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client/lock.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,null,1,1,1,null,1,null,1,1,null,null,1,null,null,1,null,1,1,null,null,null,null,null,null,1,6,6,null,null,null,null,null,null,1,6,6,null,null,null,1,6,6,5,5,null,null,1,null,null,null,1,4,4,4,null,3,3,null,null,1,null,null,1,18,null,null,null,null,null,1,6,null,null,null,null,null]},"covered_strength":3.085714285714286,"covered_lines":35,"lines_of_code":35},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client/state.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,null,1,1,1,null,null,1,null,1,1,null,1,null,1,1,1,1,1,1,null,null,null,null,null,null,1,1,null,null,null,null,null,null,null,1,1,null,null,null,null,null,1,2,null,null,null,null,null,null,1,1,1,1,null,null,null,null,1,3,1,1,1,null,null,null,null,null]},"covered_strength":1.103448275862069,"covered_lines":29,"lines_of_code":29},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/version.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,null,1,null,null,null]},"covered_strength":1.0,"covered_lines":3,"lines_of_code":3}],"metrics":{"covered_percent":100.0,"covered_strength":1.8484848484848484,"covered_lines":132,"total_lines":132}}
+{"timestamp":1729724582,"command_name":"Unit Tests","files":[{"filename":"/home/bougyman/rubyists/dapr/lib/dapr.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,null,null,1,1,7,null,null,null,1,1,1,1,1,null,null]},"covered_strength":1.6,"covered_lines":10,"lines_of_code":10},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,1,1,1,null,1,1,null,1,1,1,1,1,1,null,1,4,null,1,1,null,null,1,11,null,null,1,1,null,null,1,14,null,null,null,1,1,null,1,5,null,null,1,1,1,1,null,1,null,null,1,1,null,null,null,null,null]},"covered_strength":1.8823529411764706,"covered_lines":34,"lines_of_code":34},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client/configuration.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,null,1,1,1,null,1,null,1,1,null,null,1,null,null,1,null,1,1,null,1,1,1,null,null,null,null,null,null,null,1,1,1,1,null,null,1,1,1,null,null,null,null,null]},"covered_strength":1.0,"covered_lines":21,"lines_of_code":21},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client/lock.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,null,1,1,1,null,1,null,1,1,null,null,1,null,null,1,null,1,1,null,null,null,null,null,null,1,6,6,null,null,null,null,null,null,1,6,6,null,null,null,1,6,6,5,5,null,null,1,null,null,null,1,4,4,4,null,3,3,null,null,1,null,null,1,18,null,null,null,null,null,1,6,null,null,null,null,null]},"covered_strength":3.085714285714286,"covered_lines":35,"lines_of_code":35},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/client/state.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,null,1,1,1,null,null,1,null,1,1,null,1,null,1,1,1,1,1,1,1,null,null,null,null,null,null,1,1,null,null,null,null,null,null,null,1,1,null,null,null,null,null,1,2,null,null,null,null,null,null,1,1,1,3,null,null,null,null,1,3,1,1,1,null,null,null,null,null]},"covered_strength":1.1666666666666667,"covered_lines":30,"lines_of_code":30},{"filename":"/home/bougyman/rubyists/dapr/lib/dapr/version.rb","covered_percent":100.0,"coverage":{"lines":[null,null,1,1,null,1,null,null,null]},"covered_strength":1.0,"covered_lines":3,"lines_of_code":3}],"metrics":{"covered_percent":100.0,"covered_strength":1.8571428571428572,"covered_lines":133,"total_lines":133}}

lib/dapr/client/state.rb

@@ -14,6 +14,7 @@ class State
 
         attr_reader :store_name
 
+        Item                 = Struct.new(:data, :etag, :metadata)
         Empty                = Google::Protobuf::Empty
         Runtime              = Client::Runtime
         GetBulkStateResponse = Runtime::GetBulkStateResponse
@@ -53,11 +54,13 @@ def initialize(store_name)
         def get(keys, metadata: {})
           logger.debug('Getting state', keys:, store_name:, metadata:)
           response = singleton.get_bulk_state GetStateRequest.new(store_name:, keys:, metadata:)
-          response.items
+          response.items.to_h { |i| [i.key, Item.new(data: i.data, etag: i.etag, metadata: i.metadata)] }
         end
 
         # @param states     [Hash] states to set (key/values in the state store)
         # @param metadata   [Hash] metadata to include
+        #
+        # @return [Empty] The response from the Dapr State Management component (Empty means success)
         def set(states, metadata: {})
           states  = states.map { |key, value| { key:, value:, metadata: } }
           request = SaveStateRequest.new(store_name:, states:)

test/dapr/client/test_state.rb

@@ -45,17 +45,15 @@ def testy?
     @testy
   end
 
-  context 'State' do # rubocop:disable Metrics/BlockLength
+  context 'State' do
     should 'Read existing State item' do
       make_it_testy!
       messages = semantic_logger_events(Rubyists::Dapr::Client::State) do
         states = Rubyists::Dapr::Client::State.get('test_item1', 'test_item2')
 
         assert_equal 2, states.size
-        assert_equal 'test-state-data-0', states[0].data
-        assert_equal 'test_item1', states[0].key
-        assert_equal 'test_item2', states[1].key
-        assert_equal 'test-state-data-1', states[1].data
+        assert_equal 'test-state-data-0', states['test_item1'].data
+        assert_equal 'test-state-data-1', states['test_item2'].data
       end
 
       assert_equal 1, messages.size