feat: Support to_h and to_json methods for LDContext (#284)

Author: keelerm84

lib/ldclient-rb/context.rb

@@ -334,6 +334,49 @@ def [](key)
       multi_kind? ? individual_context(key.to_s) : get_value(key)
     end
 
+    #
+    # Convert the LDContext to a JSON string.
+    #
+    # @param args [Array]
+    # @return [String]
+    #
+    def to_json(*args)
+      JSON.generate(to_h, *args)
+    end
+
+    #
+    # Convert the LDContext to a hash. If the LDContext is invalid, the hash will contain an error key with the error
+    # message.
+    #
+    # @return [Hash]
+    #
+    def to_h
+      return {error: error} unless valid?
+      return hash_single_kind unless multi_kind?
+
+      hash = {kind: 'multi'}
+      @contexts.each do |context|
+        single_kind_hash = context.to_h
+        kind = single_kind_hash.delete(:kind)
+        hash[kind] = single_kind_hash
+      end
+
+      hash
+    end
+
+    protected def hash_single_kind
+      hash = attributes.nil? ? {} : attributes.clone
+
+      hash[:kind] = kind
+      hash[:key] = key
+
+      hash[:name] = name unless name.nil?
+      hash[:anonymous] = anonymous if anonymous
+      hash[:_meta] = {privateAttributes: private_attributes} unless private_attributes.empty?
+
+      hash
+    end
+
     #
     # Retrieve the value of any top level, addressable attribute.
     #

lib/ldclient-rb/reference.rb

@@ -238,6 +238,16 @@ def hash
       ([error] + components).hash
     end
 
+    #
+    # Convert the Reference to a JSON string.
+    #
+    # @param args [Array]
+    # @return [String]
+    #
+    def to_json(*args)
+      JSON.generate(@raw_path, *args)
+    end
+
     #
     # Performs unescaping of attribute reference path components:
     #

spec/context_spec.rb

@@ -1,4 +1,5 @@
 require "ldclient-rb/context"
+require "json"
 
 module LaunchDarkly
   describe LDContext do
@@ -148,6 +149,64 @@ module LaunchDarkly
           expect(org_first.fully_qualified_key).to eq("org:b-org-key:user:a-user-key")
         end
       end
+
+      describe "converts back to JSON format" do
+        it "single kind contexts" do
+          contextHash = {
+            key: "launchdarkly",
+            kind: "org",
+            address: {
+              street: "1999 Harrison St Suite 1100",
+              city: "Oakland",
+              state: "CA",
+              zip: "94612",
+              _meta: {
+                privateAttributes: ["city"],
+              },
+            },
+          }
+          context = subject.create(contextHash)
+          contextJson = context.to_json
+          backToHash = JSON.parse(contextJson, symbolize_names: true)
+
+          expect(backToHash).to eq(contextHash)
+        end
+
+        it "multi kind contexts" do
+          contextHash = {
+            kind: "multi",
+            "org": {
+              key: "launchdarkly",
+              address: {
+                street: "1999 Harrison St Suite 1100",
+                city: "Oakland",
+                state: "CA",
+                zip: "94612",
+              },
+              _meta: {
+                privateAttributes: ["address/city"],
+              },
+            },
+            "user": {
+              key: "user-key",
+              name: "Ruby",
+              anonymous: true,
+            },
+          }
+          context = subject.create(contextHash)
+          contextJson = context.to_json
+          backToHash = JSON.parse(contextJson, symbolize_names: true)
+
+          expect(backToHash).to eq(contextHash)
+        end
+
+        it "invalid context returns error" do
+          context = subject.create({ key: "", kind: "user", name: "testing" })
+          expect(context.valid?).to be false
+          expect(context.to_h).to eq({ error: "context key must not be empty" })
+          expect(context.to_json).to eq({ error: "context key must not be empty" }.to_json)
+        end
+      end
     end
 
     describe "context counts" do