graphd 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2d4e121c4e6a3a5150912b20ae0bca19a48d2e9de535c965615a7d5558bb770
+  data.tar.gz: e4af93a38448a47796d19c54a50adf9921222f0dc2c4dbbd18882270bae74924
+SHA512:
+  metadata.gz: f3d9a2613043742932f0fc4e50253c9ca82f55611af86a0556a5168ffcb4e7be1c7122c3bce3c9eb6e14c8695c0650fb2f290db951e3cda1517a96a8dc5750fe
+  data.tar.gz: 2afdaca018157f54aa5851371257582231574ccd82f6315cd7f8129b9c46ae54c2f9a8f01c6350c4a3508c4326681b2c1d05577e7c3343cc30794aa79add5b8b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - 'lib/protos'
+    - 'lib/graphd/api_pb.rb'
+    - 'lib/graphd/api_services_pb.rb'
+  TargetRubyVersion: 2.7

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at iamgeorgethomas@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in graphd.gemspec
+gemspec
+
+gem 'grpc'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    graphd (0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.4.4)
+    google-protobuf (3.14.0)
+    googleapis-common-protos-types (1.0.5)
+      google-protobuf (~> 3.11)
+    grpc (1.34.0)
+      google-protobuf (~> 3.13)
+      googleapis-common-protos-types (~> 1.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  graphd!
+  grpc
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 George Thomas
+
+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,40 @@
+# Graphd
+A Ruby client for [DGraph](https://github.com/dgraph-io/dgraph) that uses [gRPC](https://grpc.io/).
+
+This client follows [pydgraph](https://github.com/dgraph-io/pydgraph) closely.
+
+**This gem is under active development. The API may change in future versions**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'graphd'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install graphd
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thegeorgeous/graphd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/thegeorgeous/graphd/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Graphd project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thegeorgeous/graphd/blob/master/CODE_OF_CONDUCT.md).
+
+## TODO
+- Add support for metadata headers
+- Add support for timeouts
+- Add support for credentials
+- Add support for async calls

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'graphd'
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

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/examples/simple_example.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'graphd'
+
+def client_stub
+  @client_stub ||= Graphd::ClientStub.new('localhost:9080')
+end
+
+def client(client_stub)
+  @client ||= Graphd::Client.new(client_stub)
+end
+
+def drop_all(client)
+  client.alter(::Api::Operation.new(drop_all: true))
+end
+
+def create_schema(client)
+  schema = "
+    name: string @index(exact) .
+    friend: [uid] @reverse .
+    age: int .
+    married: bool .
+    loc: geo .
+    dob: datetime .
+    type Person {
+        name
+        friend
+        age
+        married
+        loc
+        dob
+    }
+  "
+  client.alter(::Api::Operation.new(schema: schema))
+end
+
+def create_data(client)
+  # Create a new transaction.
+  txn = client.txn
+  # Create data.
+  p = {
+    'uid': '_:alice',
+    'dgraph.type': 'Person',
+    'name': 'Alice',
+    'age': 26,
+    'married': true,
+    'loc': {
+      'type': 'Point',
+      'coordinates': [1.1, 2]
+    },
+    'dob': DateTime.new(1980, 1, 1, 23, 0, 0, 0),
+    'friend': [
+      {
+        'uid': '_:bob',
+        'dgraph.type': 'Person',
+        'name': 'Bob',
+        'age': 24
+      }
+    ],
+    'school': [
+      {
+        'name': 'Crown Public School'
+      }
+    ]
+  }
+  # Run mutation.
+  response = txn.mutate(set_obj: p)
+
+  # Commit transaction.
+  txn.commit
+
+  # Get uid of the outermost object (person named "Alice").
+  # response.uids returns a map from blank node names to uids.
+  p "Created person named 'Alice' with uid = #{response.uids[:alice]}"
+
+  # Clean up. Calling this after txn.commit() is a no-op and hence safe.
+  txn.discard
+end
+
+# Deleting a data
+def delete_data(client)
+  # Create a new transaction.
+  txn = client.txn
+  query1 = "query all($a: string) {
+            all(func: eq(name, $a)) {
+               uid
+            }
+        }"
+  variables1 = { '$a': 'Bob' }
+  res1 = client.txn(read_only: true).query(query1, variables: variables1)
+  ppl1 = JSON.parse(res1.json)
+
+  ppl1['all'].each do |person|
+    p "Bob's UID: #{person['uid']}"
+    txn.mutate(del_obj: person)
+    p 'Bob deleted'
+    txn.commit
+  end
+
+  txn.discard
+end
+
+# Query for data.
+def query_alice(client)
+  # Run query.
+  query = "query all($a: string) {
+        all(func: eq(name, $a)) {
+            uid
+            name
+            age
+            married
+            loc
+            dob
+            friend {
+                name
+                age
+            }
+            school {
+                name
+            }
+        }
+    }"
+
+  variables = { '$a': 'Alice' }
+  res = client.txn(read_only: true).query(query, variables: variables)
+  ppl = JSON.parse(res.json)
+
+  # Print results.
+  p "Number of people named 'Alice': #{ppl['all'].length}"
+end
+
+# Query to check for deleted node
+def query_bob(client)
+  query = "query all($b: string) {
+            all(func: eq(name, $b)) {
+                uid
+                name
+                age
+                friend {
+                    uid
+                    name
+                    age
+                }
+                ~friend {
+                    uid
+                    name
+                    age
+                }
+            }
+        }"
+
+  variables = { '$b': 'Bob' }
+  res = client.txn(read_only: true).query(query, variables: variables)
+  ppl = JSON.parse(res.json)
+
+  # Print results.
+  p "Number of people named 'Bob': #{ppl['all'].length}"
+end
+
+def upsert(client)
+  txn = client.txn
+  query = '{
+        u as var(func: eq(name, "Jonas"))
+  }'
+  nquad = '
+  uid(u) <name> "Jonas" .
+  uid(u) <age> "25" .
+'
+  mutation = txn.create_mutation(set_nquads: nquad)
+  request = txn.create_request(query: query, mutations: [mutation], commit_now: true)
+  txn.do_request(request)
+end
+
+def cond_upsert(client)
+  txn = client.txn
+  query = '
+        {
+          user as var(func: eq(name, "Jonas"))
+        }
+  '
+  cond = '@if(eq(len(user), 1))'
+  nquads = '
+         uid(user) <name> "Jonas Kahnwald" .
+  '
+  mutation = txn.create_mutation(cond: cond, set_nquads: nquads)
+  request = txn.create_request(mutations: [mutation], query: query, commit_now: true)
+  txn.do_request(request)
+end
+
+def run
+  dgraph_client = client(client_stub)
+  version = dgraph_client.check_version
+  p version
+  drop_all(dgraph_client)
+  create_schema(dgraph_client)
+  create_data(dgraph_client)
+  query_alice(dgraph_client)
+  query_bob(dgraph_client)
+  delete_data(dgraph_client)
+  query_alice(dgraph_client)
+  query_bob(dgraph_client)
+  upsert(dgraph_client)
+  cond_upsert(dgraph_client)
+end
+
+run

data/graphd.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/graphd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'graphd'
+  spec.version       = Graphd::VERSION
+  spec.authors       = ['George Thomas']
+  spec.email         = ['iamgeorgethomas@gmail.com']
+
+  spec.summary       = 'Ruby client for DGraph'
+  spec.homepage      = 'https://github.com/thegeorgeous/graphd'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://rubygems.org/graphd'
+  spec.metadata['changelog_uri'] = 'https://github.com/thegeorgeous/graphd'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/graphd.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'graphd/version'
+require_relative 'graphd/api_pb'
+require_relative 'graphd/api_services_pb'
+require_relative 'graphd/client_stub'
+require_relative 'graphd/client'

data/lib/graphd/aborted_error.rb

@@ -0,0 +1,10 @@
+# lib/aborted_error.rb
+
+module Graphd
+  # Error thrown by aborted transaction
+  class AbortedError < StandardError
+    def initialize(msg = 'Transaction has been aborted. Please retry')
+      super(msg)
+    end
+  end
+end

data/lib/graphd/api_pb.rb

@@ -0,0 +1,146 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: api.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("api.proto", :syntax => :proto3) do
+    add_message "api.Request" do
+      optional :start_ts, :uint64, 1
+      optional :query, :string, 4
+      map :vars, :string, :string, 5
+      optional :read_only, :bool, 6
+      optional :best_effort, :bool, 7
+      repeated :mutations, :message, 12, "api.Mutation"
+      optional :commit_now, :bool, 13
+    end
+    add_message "api.Uids" do
+      repeated :uids, :string, 1
+    end
+    add_message "api.Response" do
+      optional :json, :bytes, 1
+      optional :txn, :message, 2, "api.TxnContext"
+      optional :latency, :message, 3, "api.Latency"
+      optional :metrics, :message, 4, "api.Metrics"
+      map :uids, :string, :string, 12
+    end
+    add_message "api.Mutation" do
+      optional :set_json, :bytes, 1
+      optional :delete_json, :bytes, 2
+      optional :set_nquads, :bytes, 3
+      optional :del_nquads, :bytes, 4
+      repeated :set, :message, 5, "api.NQuad"
+      repeated :del, :message, 6, "api.NQuad"
+      optional :cond, :string, 9
+      optional :commit_now, :bool, 14
+    end
+    add_message "api.Operation" do
+      optional :schema, :string, 1
+      optional :drop_attr, :string, 2
+      optional :drop_all, :bool, 3
+      optional :drop_op, :enum, 4, "api.Operation.DropOp"
+      optional :drop_value, :string, 5
+      optional :run_in_background, :bool, 6
+    end
+    add_enum "api.Operation.DropOp" do
+      value :NONE, 0
+      value :ALL, 1
+      value :DATA, 2
+      value :ATTR, 3
+      value :TYPE, 4
+    end
+    add_message "api.Payload" do
+      optional :Data, :bytes, 1
+    end
+    add_message "api.TxnContext" do
+      optional :start_ts, :uint64, 1
+      optional :commit_ts, :uint64, 2
+      optional :aborted, :bool, 3
+      repeated :keys, :string, 4
+      repeated :preds, :string, 5
+    end
+    add_message "api.Check" do
+    end
+    add_message "api.Version" do
+      optional :tag, :string, 1
+    end
+    add_message "api.Latency" do
+      optional :parsing_ns, :uint64, 1
+      optional :processing_ns, :uint64, 2
+      optional :encoding_ns, :uint64, 3
+      optional :assign_timestamp_ns, :uint64, 4
+      optional :total_ns, :uint64, 5
+    end
+    add_message "api.Metrics" do
+      map :num_uids, :string, :uint64, 1
+    end
+    add_message "api.NQuad" do
+      optional :subject, :string, 1
+      optional :predicate, :string, 2
+      optional :object_id, :string, 3
+      optional :object_value, :message, 4, "api.Value"
+      optional :label, :string, 5
+      optional :lang, :string, 6
+      repeated :facets, :message, 7, "api.Facet"
+    end
+    add_message "api.Value" do
+      oneof :val do
+        optional :default_val, :string, 1
+        optional :bytes_val, :bytes, 2
+        optional :int_val, :int64, 3
+        optional :bool_val, :bool, 4
+        optional :str_val, :string, 5
+        optional :double_val, :double, 6
+        optional :geo_val, :bytes, 7
+        optional :date_val, :bytes, 8
+        optional :datetime_val, :bytes, 9
+        optional :password_val, :string, 10
+        optional :uid_val, :uint64, 11
+      end
+    end
+    add_message "api.Facet" do
+      optional :key, :string, 1
+      optional :value, :bytes, 2
+      optional :val_type, :enum, 3, "api.Facet.ValType"
+      repeated :tokens, :string, 4
+      optional :alias, :string, 5
+    end
+    add_enum "api.Facet.ValType" do
+      value :STRING, 0
+      value :INT, 1
+      value :FLOAT, 2
+      value :BOOL, 3
+      value :DATETIME, 4
+    end
+    add_message "api.LoginRequest" do
+      optional :userid, :string, 1
+      optional :password, :string, 2
+      optional :refresh_token, :string, 3
+    end
+    add_message "api.Jwt" do
+      optional :access_jwt, :string, 1
+      optional :refresh_jwt, :string, 2
+    end
+  end
+end
+
+module Api
+  Request = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Request").msgclass
+  Uids = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Uids").msgclass
+  Response = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Response").msgclass
+  Mutation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Mutation").msgclass
+  Operation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Operation").msgclass
+  Operation::DropOp = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Operation.DropOp").enummodule
+  Payload = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Payload").msgclass
+  TxnContext = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.TxnContext").msgclass
+  Check = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Check").msgclass
+  Version = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Version").msgclass
+  Latency = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Latency").msgclass
+  Metrics = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Metrics").msgclass
+  NQuad = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.NQuad").msgclass
+  Value = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Value").msgclass
+  Facet = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Facet").msgclass
+  Facet::ValType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Facet.ValType").enummodule
+  LoginRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.LoginRequest").msgclass
+  Jwt = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("api.Jwt").msgclass
+end

data/lib/graphd/api_services_pb.rb

@@ -0,0 +1,32 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: api.proto for package 'api'
+# Original file comments:
+# Style guide for Protocol Buffer 3.
+# Use CamelCase (with an initial capital) for message names – for example,
+# SongServerRequest. Use underscore_separated_names for field names – for
+# example, song_name.
+#
+
+require 'grpc'
+require_relative 'api_pb'
+
+module Api
+  module Dgraph
+    # Graph response.
+    class Service
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'api.Dgraph'
+
+      rpc :Login, ::Api::LoginRequest, ::Api::Response
+      rpc :Query, ::Api::Request, ::Api::Response
+      rpc :Alter, ::Api::Operation, ::Api::Payload
+      rpc :CommitOrAbort, ::Api::TxnContext, ::Api::TxnContext
+      rpc :CheckVersion, ::Api::Check, ::Api::Version
+    end
+
+    Stub = Service.rpc_stub_class
+  end
+end

data/lib/graphd/client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'api_pb'
+require_relative 'transaction'
+
+module Graphd
+  # Client initialized to talk to a DGraph instance
+  # Accepts multiple instances of Graphd::ClientStub
+  # Examples:
+  # client_stub = Graphd::ClientStub.new('localhost:9080')
+  # client = Graphd::Cilent.new(client_stub)
+  class Client
+    def initialize(*clients)
+      raise ClientError unless clients
+
+      @clients = clients
+      @jwt = Api::Jwt.new
+    end
+
+    def check_version
+      request = Api::Check.new
+      response = client.check_version(request)
+      response.tag
+    end
+
+    def alter(operation)
+      client.alter(operation)
+    end
+
+    def txn(read_only: false)
+      Transaction.new(self, read_only: read_only)
+    end
+
+    def client
+      @clients.sample
+    end
+  end
+end

data/lib/graphd/client_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Raised when there are errors in the client, duh!
+class ClientError < StandardError
+  def initialize(msg = 'No client provided')
+    super
+  end
+end

data/lib/graphd/client_stub.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'grpc'
+require_relative 'api_services_pb'
+
+module Graphd
+  # gRPC Client stub for DGraph
+  class ClientStub
+    attr_reader :stub
+
+    def initialize(
+      host = 'localhost:9080',
+      credentials = :this_channel_is_insecure,
+      channel_args = {}
+    )
+      @stub = Api::Dgraph::Stub.new(host, credentials, channel_args)
+    end
+
+    def check_version(request)
+      @stub.check_version(request)
+    end
+
+    def alter(operation)
+      @stub.alter(operation)
+    end
+
+    def query(request)
+      @stub.query(request)
+    end
+
+    def commit_or_abort(transaction_context:)
+      @stub.commit_or_abort(transaction_context)
+    end
+  end
+end

data/lib/graphd/transaction.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Graphd
+  class Transaction
+    def initialize(client, read_only: false)
+      @client = client
+      @client_stub = @client.client
+      @transaction_context = ::Api::TxnContext.new
+      @finished = false
+      @mutated = false
+      @read_only = read_only
+    end
+
+    def mutate(mutation: nil, set_obj: nil, del_obj: nil, commit_now: nil)
+      request_mutation = create_mutation(mutation: mutation, set_obj: set_obj, del_obj: del_obj)
+      commit_now ||= request_mutation.commit_now
+      request = create_request(mutations: [request_mutation], commit_now: commit_now)
+      do_request(request)
+    end
+
+    def query(query, variables: nil)
+      request = create_request(query: query, variables: variables)
+      do_request(request)
+    end
+
+    def create_mutation(mutation: nil, set_obj: nil, del_obj: nil, set_nquads: nil, del_nquads: nil, cond: nil)
+      mutation ||= ::Api::Mutation.new
+
+      mutation.set_json = set_obj.to_json if set_obj
+      mutation.delete_json = del_obj.to_json if del_obj
+      mutation.set_nquads = set_nquads if set_nquads
+      mutation.del_nquads = del_nquads if del_nquads
+      mutation.cond = cond if cond
+
+      mutation
+    end
+
+    def create_request(query: nil, variables: nil, mutations: nil, commit_now: nil)
+      request = ::Api::Request.new(start_ts: @transaction_context.start_ts, commit_now: commit_now)
+      variables&.each do |key, value|
+        if key.is_a?(String) && value.is_a?(String)
+          raise TransactionError, 'Values and keys in variable map must be strings'
+        end
+
+        request.vars[key] = value
+      end
+
+      request.query = query if query
+      request.mutations += mutations if mutations
+
+      request
+    end
+
+    def do_request(request)
+      raise TransactionError, 'Transaction has already been committed or discarded' if @finished
+
+      if request.mutations.length.positive?
+        raise TransactionError, 'Readonly transaction cannot run mutations' if @read_only
+
+        @mutated = true
+      end
+
+      query_error = nil
+
+      begin
+        @response = @client_stub.query(request)
+      rescue StandardError => e
+        query_error = e
+      end
+
+      discard if query_error
+
+      @finished = true if request.commit_now
+
+      merge_context(@response.txn)
+
+      @response
+    end
+
+    def discard
+      return unless common_discard
+
+      @client_stub.commit_or_abort(transaction_context: @transaction_context)
+    end
+
+    def merge_context(src = nil)
+      # This condition will be true only if the server doesn't return a
+      # txn context after a query or mutation.
+      return unless src
+
+      if @transaction_context.start_ts.zero?
+        @transaction_context.start_ts = src.start_ts
+      elsif @transaction_context.start_ts != src.start_ts
+        # This condition should never be true.
+        raise TransactionError, 'StartTs mismatch'
+      end
+
+      @transaction_context.keys += src.keys
+      @transaction_context.preds += src.preds
+    end
+
+    def commit
+      return unless common_commit
+
+      begin
+        @client_stub.commit_or_abort(transaction_context: @transaction_context)
+      rescue StandardError => e
+        common_except_commit(e)
+      end
+    end
+
+    private
+
+    def common_discard
+      return false if @finished
+
+      @finished = true
+      return false unless @mutated
+
+      @transaction_context.aborted = true
+      true
+    end
+
+    def common_commit
+      raise TransactionError, 'Readonly transaction cannot run mutations or be committed' if @read_only
+
+      raise TransactionError, 'Transaction has already been committed or discarded' if @finished
+
+      @finished = true
+      @mutated
+    end
+
+    def common_except_commit(error)
+      raise error
+    end
+  end
+end

data/lib/graphd/transaction_error.rb

@@ -0,0 +1,6 @@
+# lib/transaction_error.rb
+
+module Graphd
+  class TransactionError < StandardError
+  end
+end

data/lib/graphd/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Graphd
+  VERSION = '0.4.0'
+end

data/lib/protos/api.proto

@@ -0,0 +1,176 @@
+// Style guide for Protocol Buffer 3.
+// Use CamelCase (with an initial capital) for message names – for example,
+// SongServerRequest. Use underscore_separated_names for field names – for
+// example, song_name.
+
+syntax = "proto3";
+
+package api;
+
+/* import "gogoproto/gogo.proto"; */
+
+/* option (gogoproto.marshaler_all) = true; */
+/* option (gogoproto.sizer_all) = true; */
+/* option (gogoproto.unmarshaler_all) = true; */
+/* option (gogoproto.goproto_getters_all) = true; */
+
+option java_package = "io.dgraph";
+option java_outer_classname = "DgraphProto";
+
+// Graph response.
+service Dgraph {
+	rpc Login (LoginRequest)       returns (Response) {}
+	rpc Query (Request)            returns (Response) {}
+	rpc Alter (Operation)          returns (Payload) {}
+	rpc CommitOrAbort (TxnContext) returns (TxnContext) {}
+	rpc CheckVersion(Check)        returns (Version) {}
+}
+
+message Request {
+	uint64 start_ts = 1;
+
+	string query = 4;
+	map<string, string> vars = 5; // Support for GraphQL like variables.
+	bool read_only = 6;
+	bool best_effort = 7;
+
+	repeated Mutation mutations = 12;
+	bool commit_now = 13;
+}
+
+message Uids {
+	repeated string uids = 1;
+}
+
+message Response {
+	bytes json = 1;
+	TxnContext txn = 2;
+	Latency latency = 3;
+	// Metrics contains all metrics related to the query.
+	Metrics metrics = 4;
+	// uids contains a mapping of blank_node => uid for the node. It only returns uids
+	// that were created as part of a mutation.
+	map<string, string> uids = 12;
+}
+
+message Mutation {
+	bytes set_json = 1;
+	bytes delete_json = 2;
+	bytes set_nquads = 3;
+	bytes del_nquads = 4;
+	repeated NQuad set = 5;
+	repeated NQuad del = 6;
+
+	// This is being used for upserts.
+	string cond = 9;
+
+	// This field is a duplicate of the one in Request and placed here for convenience.
+	bool commit_now = 14;
+}
+
+message Operation {
+	string schema = 1;
+	string drop_attr = 2;
+	bool drop_all = 3;
+
+	enum DropOp {
+		NONE = 0;
+		ALL = 1;
+		DATA = 2;
+		ATTR = 3;
+		TYPE = 4;
+	}
+	DropOp drop_op = 4;
+
+	// If drop_op is ATTR or TYPE, drop_value holds the name of the predicate or
+	// type to delete.
+	string drop_value = 5;
+
+	// run indexes in background.
+	bool run_in_background = 6;
+}
+
+// Worker services.
+message Payload {
+	bytes Data = 1;
+}
+
+message TxnContext {
+	uint64 start_ts = 1;
+	uint64 commit_ts = 2;
+	bool aborted = 3;
+	repeated string keys = 4;  // List of keys to be used for conflict detection.
+	repeated string preds = 5; // List of predicates involved in this transaction.
+}
+
+message Check {}
+
+message Version {
+	string tag = 1;
+}
+
+message Latency {
+	uint64 parsing_ns = 1;
+	uint64 processing_ns = 2;
+	uint64 encoding_ns = 3;
+	uint64 assign_timestamp_ns = 4;
+	uint64 total_ns = 5;
+}
+
+message Metrics {
+	// num_uids is the map of number of uids processed by each attribute.
+	map<string, uint64> num_uids = 1;
+}
+
+message NQuad {
+	string subject = 1;
+	string predicate = 2;
+	string object_id = 3;
+	Value object_value = 4;
+	string label = 5;
+	string lang = 6;
+	repeated Facet facets = 7;
+}
+
+message Value {
+	oneof val {
+		string default_val = 1;
+		bytes bytes_val = 2;
+		int64 int_val = 3;
+		bool bool_val = 4;
+		string str_val = 5;
+		double double_val = 6;
+		bytes geo_val = 7;  // Geo data in WKB format
+		bytes date_val = 8;
+		bytes datetime_val = 9;
+		string password_val = 10;
+		uint64 uid_val=11;
+	}
+}
+
+message Facet {
+	enum ValType {
+		STRING = 0;
+		INT = 1;
+		FLOAT = 2;
+		BOOL = 3;
+		DATETIME = 4;
+	}
+
+	string key = 1;
+	bytes value = 2;
+	ValType val_type = 3;
+	repeated string tokens = 4; // tokens of value.
+	string alias = 5; // not stored, only used for query.
+}
+
+message LoginRequest {
+	string userid = 1;
+	string password = 2;
+	string refresh_token = 3;
+}
+
+message Jwt {
+	string access_jwt = 1;
+	string refresh_jwt = 2;
+}

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: graphd
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- George Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- iamgeorgethomas@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/simple_example.rb
+- graphd.gemspec
+- lib/graphd.rb
+- lib/graphd/aborted_error.rb
+- lib/graphd/api_pb.rb
+- lib/graphd/api_services_pb.rb
+- lib/graphd/client.rb
+- lib/graphd/client_error.rb
+- lib/graphd/client_stub.rb
+- lib/graphd/transaction.rb
+- lib/graphd/transaction_error.rb
+- lib/graphd/version.rb
+- lib/protos/api.proto
+homepage: https://github.com/thegeorgeous/graphd
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/thegeorgeous/graphd
+  source_code_uri: https://rubygems.org/graphd
+  changelog_uri: https://github.com/thegeorgeous/graphd
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Ruby client for DGraph
+test_files: []