support for REST response, resultDataContents

Author: andreasronge

README.md

@@ -53,6 +53,15 @@ Single statement
 # => [%{x: 0}, %{x: 1}, %{x: 2}]
 ```
 
+REST response
+
+```elixir
+{:ok, response} = commit(session, statement: "CREATE (n {name: 'andreas'}) RETURN n", resultDataContents: [ "REST" ])
+# => [%{n: %{"all_relationships" => "http://localhost:7474/db/data/node/886/relationships/all",
+#    "all_typed_relationships" => "http://localhost:7474/db/data/node/886/relationships/all/{-list|&|types}",
+# ...
+```
+
 Multiple statements
 
 ```

lib/neoxir.ex

@@ -29,6 +29,7 @@ defmodule Neoxir do
 
   def commit(session, statements) when is_list statements do
     response = Neoxir.TxEndPoint.commit(session, statements)
+
     case Neoxir.CypherResponse.to_rows(response) do
       {:ok, rows} -> {:ok, List.first(rows)}
       {:error, location, reasons} -> {:error, location, List.first(reasons)}

lib/neoxir/cypher_response.ex

@@ -25,7 +25,10 @@ defmodule Neoxir.CypherResponse do
   end
 
   defp rows(data) do
-    Enum.map(data, fn %{"row" => row} -> row end)
+    Enum.map(data, fn 
+        %{"row"  => row}  -> row 
+        %{"rest" => rest} -> rest
+    end)
   end
 
 end

lib/neoxir/tx_end_point.ex

@@ -29,9 +29,9 @@ defmodule Neoxir.TxEndPoint do
   # You begin a new transaction by posting zero or more Cypher statements to the transaction endpoint. 
   # The server will respond with the result of your statements, as well as the location of your open transaction.
   def begin_tx(%Neoxir.Session{tx_end_point_url: tx_end_point_url}, statements \\ []) do
-    {:ok, payload}  = JSX.encode [statements: statements]
-    {:ok, response} = HTTPoison.post(tx_end_point_url, payload, @headers)
-    {:ok, body }    = JSX.decode response.body
+    payload  = JSX.encode! statements: statements
+    response = HTTPoison.post!(tx_end_point_url, payload, @headers)
+    body     = JSX.decode! response.body
 
     %Neoxir.Transaction{commit_url: body["commit"], errors: body["errors"], expires: body["transaction"]["expires"]}
   end

test/cypher_response_test.exs

@@ -33,6 +33,15 @@ defmodule NeoxirCypherResponseTest do
       assert rows == [[%{x1: 253}], [%{x2: 254}]]
     end
 
+    test "with rest response" do
+      body = "{\"results\":[{\"columns\":[\"n\"],\"data\":[{\"rest\":[{\"outgoing_relationships\":\"http://localhost:7474/db/data/node/849/relationships/out\",\"labels\":\"http://localhost:7474/db/data/node/849/labels\",\"traverse\":\"http://localhost:7474/db/data/node/849/traverse/{returnType}\",\"all_typed_relationships\":\"http://localhost:7474/db/data/node/849/relationships/all/{-list|&|types}\",\"self\":\"http://localhost:7474/db/data/node/849\",\"property\":\"http://localhost:7474/db/data/node/849/properties/{key}\",\"outgoing_typed_relationships\":\"http://localhost:7474/db/data/node/849/relationships/out/{-list|&|types}\",\"properties\":\"http://localhost:7474/db/data/node/849/properties\",\"incoming_relationships\":\"http://localhost:7474/db/data/node/849/relationships/in\",\"create_relationship\":\"http://localhost:7474/db/data/node/849/relationships\",\"paged_traverse\":\"http://localhost:7474/db/data/node/849/paged/traverse/{returnType}{?pageSize,leaseTime}\",\"all_relationships\":\"http://localhost:7474/db/data/node/849/relationships/all\",\"incoming_typed_relationships\":\"http://localhost:7474/db/data/node/849/relationships/in/{-list|&|types}\",\"metadata\":{\"id\":849,\"labels\":[]},\"data\":{}}]}]}],\"errors\":[]}"
+      response = %Neoxir.CypherResponse{body: body}
+      {:ok, [rows|_]} = Neoxir.CypherResponse.to_rows(response) 
+      assert length(rows) == 1
+      assert rows |> List.first |> Dict.keys == [:n]
+      assert rows |> List.first |> Dict.get(:n) |> Dict.get("data") == %{}
+    end
+
     test "complex results" do
       body =  "{\"results\":[{\"columns\":[\"name\",\"related_type\",\"related_to\"],\"data\":[{\"row\":[\"Tom Hanks\",\"ACTED_IN\",{\"roles\":[\"Zachry\",\"Dr. Henry Goose\",\"Isaac Sachs\",\"Dermot Hoggins\"]}]},{\"row\":[\"Hugo Weaving\",\"ACTED_IN\",{\"roles\":[\"Bill Smoke\",\"Haskell Moore\",\"Tadeusz Kesselring\",\"Nurse Noakes\",\"Boardman Mephi\",\"Old Georgie\"]}]},{\"row\":[\"Halle Berry\",\"ACTED_IN\",{\"roles\":[\"Luisa Rey\",\"Jocasta Ayrs\",\"Ovid\",\"Meronym\"]}]},{\"row\":[\"Jim Broadbent\",\"ACTED_IN\",{\"roles\":[\"Vyvyan Ayrs\",\"Captain Molyneux\",\"Timothy Cavendish\"]}]},{\"row\":[\"Tom Tykwer\",\"DIRECTED\",{}]},{\"row\":[\"Andy Wachowski\",\"DIRECTED\",{}]},{\"row\":[\"Lana Wachowski\",\"DIRECTED\",{}]},{\"row\":[\"Stefan Arndt\",\"PRODUCED\",{}]},{\"row\":[\"David Mitchell\",\"WROTE\",{}]},{\"row\":[\"Jessica Thompson\",\"REVIEWED\",{\"summary\":\"An amazing journey\",\"rating\":95}]}]}],\"errors\":[]}"
       response = %Neoxir.CypherResponse{body: body}

test/neoxir_test.exs

@@ -35,6 +35,15 @@ defmodule NeoxirTest do
       assert is_number(first_row[:x])
     end
 
+    test "commit: with REST response", %{session: session}  do
+      {:ok, rows} = commit(session, statement: "CREATE (n {name: 'andreas'}) RETURN n", resultDataContents: [ "REST" ])
+      assert length(rows) == 1
+      assert rows |> List.first |> Dict.keys == [:n]
+      assert rows |> List.first |> Dict.get(:n) |> Dict.get("data") == %{"name" => "andreas"}
+    end
+
+
+
     test "commit: many valid statements", %{session: session} do
       statements = [
         [statement: "CREATE (n) RETURN ID(n) as x1"],
@@ -81,6 +90,7 @@ defmodule NeoxirTest do
       assert is_number(first_row[:x])
     end
 
+
     test "commit!: invalid statement", %{session: session} do
       assert_raise Neoxir.CypherResponseError, ~r/Invalid input/, fn ->
         commit!(session, statement: "CCCCREATE (n) RETURN ID(n) as x")

test/tx_end_point_test.exs

@@ -11,26 +11,35 @@ defmodule NeoxirTxEndPointTest do
      end
 
 
-     test "Neoxir.TxEndPoint.commit: many valid cypher queries", %{session: session}  do
+     test "many valid cypher queries", %{session: session}  do
       statements = [
         [statement: "CREATE (n) RETURN ID(n) as x1"],
         [statement: "CREATE (n) RETURN ID(n) as x2"]
       ]
 
-      response = Neoxir.TxEndPoint.commit(session, statements) # , resultDataContents: [ "REST" ]
+      response = Neoxir.TxEndPoint.commit(session, statements)
       assert response.status_code == 200
       assert String.valid?(response.body)
     end
 
 
-    test "Neoxir.TxEndPoint.commit: a valid cypher query", %{session: session} do
+    test "with rest response", %{session: session} do
+      statement = "CREATE (TheMatrix:Movie {title:'The Matrix', released:1999, tagline:'Welcome to the Real World'}) return TheMatrix"
+      response = Neoxir.TxEndPoint.commit(session, statement: statement, resultDataContents: [ "REST" ])
+      assert response.status_code == 200
+      assert String.valid?(response.body)
+      assert Regex.match?(~r/metadata/, response.body)
+    end
+
+
+    test "a valid cypher query", %{session: session} do
       response = Neoxir.TxEndPoint.commit(session, statement: "CREATE (n) RETURN ID(n)") 
       assert response.status_code == 200
       assert String.valid?(response.body)
     end
 
 
-    test "Neoxir.TxEndPoint.commit and to_rows", %{session: session} do
+    test "commit and to_rows", %{session: session} do
       response = Neoxir.TxEndPoint.commit(session, statement: "CREATE (n) RETURN ID(n) as x") 
       {:ok, rows} = Neoxir.CypherResponse.to_rows(response) 
 
@@ -44,7 +53,7 @@ defmodule NeoxirTxEndPointTest do
     end
 
 
-    test "commit an invalid cypher query", %{session: session} do
+    test "an invalid cypher query", %{session: session} do
       response = Neoxir.TxEndPoint.commit(session, statement: "CREATEA (n) RETURN ID(n)")
       assert response.status_code == 200
       assert String.valid?(response.body)