redgraph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80c7cce1d1d19897882873e07e7a5a1fadabbb52d14717e16ff113f83511b32a
+  data.tar.gz: 72be15f7b95a7b45ec9ec21adb54f54676e0f960938c602fbb8381ae3ca1c682
+SHA512:
+  metadata.gz: cce480b50ada0fb75bb1491d730668a8ac7f92be766dd161b1b3c3fa8082d579d7276383adb2966894388f6c95fb7e444abd9eb2935e50f6659d35be938df450
+  data.tar.gz: 806e2105e78b9c6a188dd271ed7b6315ec9afbe0bbd6d1008eb2c4f991e756512e7b4a83dbb7808b944ab2c8b66671f270cb1a4008a476945c9f20818209dad9

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-04-08
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redgraph.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+gem "pry", "~> 0.14.0"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    redgraph (0.1.0)
+      redis (~> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.3)
+    redis (4.2.5)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry (~> 0.14.0)
+  rake (~> 13.0)
+  redgraph!
+
+BUNDLED WITH
+   2.2.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Paolo Zaccagnini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Redgraph
+
+A simple RedisGraph library. This gem owes **a lot** to the existing [redisgraph-rb](https://github.com/RedisGraph/redisgraph-rb) gem, but tries to provide a friendlier interface, similar to the existing [Python](https://github.com/RedisGraph/redisgraph-py) and [Elixir](https://github.com/crflynn/redisgraph-ex) clients.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redgraph'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install redgraph
+
+## Usage
+
+Basic usage:
+
+    graph = Redgraph::Graph.new('movies', url: "redis://localhost:6379/1")
+
+Create a couple nodes:
+
+    actor = Redgraph::Node.new(label: 'actor', attributes: {name: "Al Pacino"})
+    graph.add_node(actor)
+    film = Redgraph::Node.new(label: 'film', attributes: {name: "Scarface"})
+    graph.add_node(film)
+
+Create an edge between those nodes:
+
+    edge = Redgraph::Edge.new(src: actor, dest: film, type: 'ACTOR_IN', properties: {role: "Tony Montana"})
+    result = @graph.add_edge(edge)
+
+Find a node by id:
+
+    @graph.find_node_by_id(123)
+
+To get all nodes:
+
+    @graph.nodes
+
+Optional filters:
+
+    @graph.nodes(label: 'actor')
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run 
+
+    TEST_REDIS_URL=YOUR-REDIS-URL rake test
+
+to run the tests.
+
+You can use a `TEST_REDIS_URL` such as `redis://localhost:6379/1`. Make sure you're not overwriting important databases.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+Run `bin/console` for an interactive prompt.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pzac/redgraph.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "redgraph"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redgraph.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "redis"
+
+require_relative "redgraph/version"
+require_relative "redgraph/graph"
+require_relative "redgraph/node"
+require_relative "redgraph/edge"
+require_relative "redgraph/query_response"
+
+module Redgraph
+  class Error < StandardError; end
+  class ServerError < Error; end
+end

data/lib/redgraph/edge.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Redgraph
+  class Edge
+    attr_accessor :id, :src, :dest, :type, :properties
+
+    def initialize(src:, dest:, type:, properties: {})
+      @src = src
+      @dest = dest
+      @type = type
+      @properties = properties
+    end
+
+    def persisted?
+      !id.nil?
+    end
+  end
+end

data/lib/redgraph/graph.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Redgraph
+  class Graph
+    attr_accessor :connection, :graph_name
+
+    def initialize(graph, redis_options = {})
+      @graph_name = graph
+      @connection = Redis.new(redis_options)
+      @module_version = module_version
+      raise ServerError unless @module_version
+    end
+
+    # Returns the version of the RedisGraph module
+    #
+    def module_version
+      modules = @connection.call("MODULE", "LIST")
+      module_graph = modules.detect { |_, name, _, version| name == 'graph' }
+      module_graph[3] if module_graph
+    end
+
+    # Deletes an existing graph
+    #
+    def delete
+      @connection.call("GRAPH.DELETE", graph_name)
+    rescue Redis::CommandError => e
+      # Catch exception if the graph was already deleted
+      return nil if e.message =~ /ERR Invalid graph operation on empty key/
+      raise e
+    end
+
+    # Returns an array of existing graphs
+    #
+    def list
+      @connection.call("GRAPH.LIST")
+    end
+
+    # Returns an array of existing labels
+    #
+    def labels
+      result = query("CALL db.labels()")
+      result.resultset.map(&:values).flatten
+    end
+
+    # Returns an array of existing properties
+    #
+    def properties
+      result = query("CALL db.propertyKeys()")
+      result.resultset.map(&:values).flatten
+    end
+
+    # Adds a node. If successul it returns the created object, otherwise false
+    #
+    def add_node(node)
+      result = query("CREATE (n:`#{node.label}` #{quote_hash(node.properties)}) RETURN ID(n)")
+      return false if result.stats[:nodes_created] != 1
+      id = result.resultset.first["ID(n)"]
+      node.id = id
+      node
+    end
+
+    def find_node_by_id(id)
+      result = query("MATCH (node) WHERE ID(node) = #{id} RETURN node")
+      return nil if result.resultset.empty?
+      (node_id, labels, properties) = result.resultset.first["node"]
+      attrs = {}
+
+      properties.each do |(index, type, value)|
+        attrs[get_property(index)] = value
+      end
+      Node.new(label: get_label(labels.first), properties: attrs).tap do |node|
+        node.id = node_id
+      end
+    end
+
+    def nodes(label: nil)
+      node_or_node_with_label = label ? "node:`#{label}`" : "node"
+
+      cmd = "MATCH (#{node_or_node_with_label}) RETURN node"
+      result = query(cmd)
+
+      result.resultset.map do |item|
+        (node_id, labels, properties) = item["node"]
+        attrs = {}
+
+        properties.each do |(index, type, value)|
+          attrs[get_property(index)] = value
+        end
+        Node.new(label: get_label(labels.first), properties: attrs).tap do |node|
+          node.id = node_id
+        end
+      end
+    end
+
+    # Adds an edge. If successul it returns the created object, otherwise false
+    #
+    def add_edge(edge)
+      result = query("MATCH (src), (dest)
+                      WHERE ID(src) = #{edge.src.id} AND ID(dest) = #{edge.dest.id}
+                      CREATE (src)-[e:`#{edge.type}` #{quote_hash(edge.properties)}]->(dest) RETURN ID(e)")
+      return false if result.stats[:relationships_created] != 1
+      id = result.resultset.first["ID(e)"]
+      edge.id = id
+      edge
+    end
+
+    private
+
+    def query(cmd)
+      data = @connection.call("GRAPH.QUERY", graph_name, cmd, "--compact")
+      QueryResponse.new(data)
+    end
+
+    def quote_hash(hash)
+      out = "{"
+      hash.each do |k,v|
+        out += "#{k}:#{escape_value(v)}"
+      end
+      out + "}"
+    end
+
+    def escape_value(x)
+      case x
+      when Integer then x
+      else
+        "'#{x}'"
+      end
+    end
+
+    def get_label(id)
+      @labels ||= labels
+      @labels[id] || (@labels = labels)[id]
+    end
+
+    def get_property(id)
+      @properties ||= properties
+      @properties[id] || (@properties = properties)[id]
+    end
+  end
+end

data/lib/redgraph/node.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Redgraph
+  class Node
+    attr_accessor :id, :label, :properties
+
+    def initialize(label:, properties: {})
+      @label = label
+      @properties = properties
+    end
+
+    def persisted?
+      !id.nil?
+    end
+
+    def ==(other)
+      super || other.instance_of?(self.class) && !id.nil? && other.id == id
+    end
+  end
+end

data/lib/redgraph/query_response.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Redgraph
+  # Wraps the GRAPH.QUERY response, assuming we use the `--compact` output.
+  #
+  # The response is an array with these objects:
+  #
+  # - header row
+  # - result rows
+  # - query stats
+  #
+  class QueryResponse
+    def initialize(response)
+      @response = response
+    end
+
+    def stats
+      @stats ||= parse_stats
+    end
+
+    def entities
+      @entities ||= parse_header
+    end
+
+    def resultset
+      @resultset ||= parse_resultset
+    end
+
+    private
+
+    # The header lists the entities described in the RETURN clause. It is an
+    # array of [ColumnType (enum), name (string)] elements. We can ignore the
+    # enum, it is always 1 (COLUMN_SCALAR).
+    def parse_header
+      @response[0].map{|item| item[1]}
+    end
+
+    def parse_stats
+      stats = {}
+
+      @response[2].each do |item|
+        label, value = item.split(":")
+
+        case label
+        when /^Nodes created/
+          stats[:nodes_created] = value.to_i
+        when /^Relationships created/
+          stats[:relationships_created] = value.to_i
+        when /^Properties set/
+          stats[:properties_set] = value.to_i
+        when /^Query internal execution time/
+          stats[:internal_execution_time] = value
+        end
+      end
+
+      stats
+    end
+
+    # The resultset has one element per entity (as described by the header)
+    def parse_resultset
+      @response[1].map do |item|
+        out = {}
+
+        item.each.with_index do |(type, value), i|
+          out[entities[i]] = value
+        end
+
+        out
+      end
+    end
+  end
+end

data/lib/redgraph/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Redgraph
+  VERSION = "0.1.0"
+end

data/redgraph.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "lib/redgraph/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redgraph"
+  spec.version       = Redgraph::VERSION
+  spec.authors       = ["Paolo Zaccagnini"]
+  spec.email         = ["hi@pzac.net"]
+
+  spec.summary       = "A simple RedisGraph client"
+  spec.homepage      = "https://github.com/pzac/redgraph"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis", "~> 4"
+end

data/test/graph_connection_test.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class GraphConnectionTest < Minitest::Test
+  def test_a_bad_connection
+    assert_raises(Redis::CannotConnectError) do
+      Redgraph::Graph.new("foobar", url: "redis://localhost:1")
+    end
+  end
+end

data/test/graph_manipulation_test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class GraphManipulationTest < Minitest::Test
+  def setup
+    @graph = Redgraph::Graph.new("movies", url: $REDIS_URL)
+  end
+
+  def teardown
+    @graph.delete
+  end
+
+  def test_add_node
+    node = Redgraph::Node.new(label: 'actor', properties: {name: "Al Pacino"})
+    result = @graph.add_node(node)
+    assert_predicate result, :persisted?
+  end
+
+  def test_add_edge
+    actor = Redgraph::Node.new(label: 'actor', properties: {name: "Al Pacino"})
+    @graph.add_node(actor)
+
+    film = Redgraph::Node.new(label: 'film', properties: {name: "Scarface"})
+    @graph.add_node(film)
+
+    edge = Redgraph::Edge.new(src: actor, dest: film, type: 'ACTOR_IN', properties: {role: "Tony Montana"})
+    result = @graph.add_edge(edge)
+
+    assert_predicate result, :persisted?
+  end
+end

data/test/graph_queries_test.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class GraphQueriesTest < Minitest::Test
+  def setup
+    @graph = Redgraph::Graph.new("movies", url: $REDIS_URL)
+    @actor = Redgraph::Node.new(label: 'actor', properties: {name: "Al Pacino"})
+    @graph.add_node(@actor)
+
+    @other_actor = Redgraph::Node.new(label: 'actor', properties: {name: "John Travolta"})
+    refute_nil(@actor.id)
+  end
+
+  def teardown
+    @graph.delete
+  end
+
+  def test_find_node_by_id
+    node = @graph.find_node_by_id(@actor.id)
+
+    refute_nil(node)
+    assert_equal("actor", node.label)
+    assert_equal("Al Pacino", node.properties["name"])
+    assert_equal(@actor.id, node.id)
+  end
+
+  def test_get_all_nodes
+    @graph.add_node(@other_actor)
+
+    actors = @graph.nodes
+
+    assert_equal(2, actors.size)
+    assert_includes(actors, @actor)
+    assert_includes(actors, @other_actor)
+  end
+
+  def test_get_all_nodes_by_label
+    @graph.add_node(@other_actor)
+    film = Redgraph::Node.new(label: 'film', properties: {name: "Scarface"})
+    @graph.add_node(film)
+
+    actors = @graph.nodes(label: 'actor')
+    assert_equal(2, actors.size)
+    assert_includes(actors, @actor)
+    assert_includes(actors, @other_actor)
+
+    films = @graph.nodes(label: 'film')
+    assert_equal(1, films.size)
+    assert_includes(films, film)
+  end
+
+  def test_find_node_by_wrong_id
+    node = @graph.find_node_by_id("-1")
+
+    assert_nil(node)
+  end
+end

data/test/graph_test.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class GraphTest < Minitest::Test
+  def setup
+    @graph = create_sample_graph("foobar")
+  end
+
+  def teardown
+    @graph.delete
+  end
+
+  def test_list
+    list = @graph.list
+    assert_includes(list, "foobar")
+  end
+
+  def test_delete
+    assert_includes(@graph.list, "foobar")
+
+    @graph.delete
+    refute_includes(@graph.list, "foobar")
+  end
+
+  def test_labels
+    @graph = create_sample_graph("foobar")
+    assert_equal(["actor"], @graph.labels)
+
+    node = Redgraph::Node.new(label: "film")
+    @graph.add_node(node)
+    assert_equal(["actor", "film"], @graph.labels)
+  end
+
+  def test_properties
+    @graph = create_sample_graph("foobar")
+    assert_equal(["name"], @graph.properties)
+
+    node = Redgraph::Node.new(label: "actor", properties: {"age": 100})
+    @graph.add_node(node)
+
+    assert_equal(["name", "age"], @graph.properties)
+  end
+
+  private
+
+  def create_sample_graph(name)
+    graph = Redgraph::Graph.new(name, url: $REDIS_URL)
+    graph.connection.call(
+      "GRAPH.QUERY",
+      name,
+      "CREATE (:actor {name: 'hello'})"
+    )
+    graph
+  end
+end

data/test/redgraph_test.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class RedgraphTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Redgraph::VERSION
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "redgraph"
+
+require "minitest/autorun"
+require "pry"
+
+unless $REDIS_URL = ENV['TEST_REDIS_URL']
+  puts "To run the tests you need to define the TEST_REDIS_URL environment variable"
+  exit(1)
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: redgraph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paolo Zaccagnini
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description:
+email:
+- hi@pzac.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redgraph.rb
+- lib/redgraph/edge.rb
+- lib/redgraph/graph.rb
+- lib/redgraph/node.rb
+- lib/redgraph/query_response.rb
+- lib/redgraph/version.rb
+- redgraph.gemspec
+- test/graph_connection_test.rb
+- test/graph_manipulation_test.rb
+- test/graph_queries_test.rb
+- test/graph_test.rb
+- test/redgraph_test.rb
+- test/test_helper.rb
+homepage: https://github.com/pzac/redgraph
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pzac/redgraph
+  source_code_uri: https://github.com/pzac/redgraph
+  changelog_uri: https://github.com/pzac/redgraph/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A simple RedisGraph client
+test_files: []