surrealdb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbdda96089dac622d235033345ffd9d51cb6e5d34e7df9431a85c9f770be94e6
+  data.tar.gz: c04b778502a1f670526228630a3056a05b837ec529030fcd0804991acd74afb0
+SHA512:
+  metadata.gz: 4038afcf4092f6b2003fa618178284b54ae6b8613cb29a25334fe4c79891f1b8d6b6f4e290ffc8251c30e415b36db59c1f255705ead0d483d9ec412095fd69bd
+  data.tar.gz: 1f03cd6327a31aa9f038cea68099b7e96b33be202a145ed6387f6cc1e3aaa106cf7372f79d393d7b4c04f6b011a424cb368a6b99b97fd80435561c3bb6019082

data/.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+charset = utf-8
+
+[*.{yml,yaml,rb}]
+indent_size = 2
+
+[*.{md,Rmd,rst}]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+indent_size = 4

data/.gitignore

@@ -0,0 +1,67 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+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 sam.kenney@me.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,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in surrealdb.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+
+gem "httpx"
+gem "rufo"
+gem "yard"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    surrealdb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    http-2-next (0.5.0)
+    httpx (0.21.0)
+      http-2-next (>= 0.4.1)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rufo (0.13.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httpx
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rufo
+  surrealdb!
+  yard
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,109 @@
+# SurrealDB
+Ruby driver for SurrealDB databases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'surrealdb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install surrealdb
+
+## Usage
+
+Included with this module are two Classes, `SurrealDB::HTTPClient` and `SurrealDB::SurrealError`, where `SurrealError` is raised for any errors that occur during the HTTP request.
+
+### HTTPClient
+Create a client with the following code:
+```ruby
+require "surrealdb"
+
+SurrealDB::HTTPClient.new(
+  "http://localhost:8000/",
+  namespace: "test",
+  database: "test",
+  username: "root",
+  password: "root"
+) do |client|
+  ...
+end
+```
+
+> The following examples assume that the client is created as above.
+
+#### `execute`
+Execute a query. It takes a string as the table name to select from, and returns `Array<Hash>`.
+
+```ruby
+client.execute("SELECT * FROM test")
+# => [{"id"=>1, "name"=>"test"}]
+
+client.execute("DELETE test:1")
+# => []
+```
+
+#### `select_all`
+Retrieve all of the data from a table. Takes a string as the table name to select from. Returns `Array<Hash>`.
+
+```ruby
+client.select_all("test")
+# => [{"id"=>1, "name"=>"test"}]
+```
+
+#### `select_one`
+Retrieve one record from a table. Takes a string as as the table name to select from, and an id of any type. Returns `Hash`.
+```ruby
+client.select_one("test", 1)
+# => {"id"=>1, "name"=>"test"}
+```
+
+#### `replace_one`
+Replace a record in a table. Takes a string as the table name the record exists in, an id of any type, and a `Hash` of values to replace. Returns `Hash`.
+```ruby
+client.replace_one("test", 1, {name: "test2", title: "test"})
+# => {"id"=>1, "name"=>"test2", "title"=>"test"}
+```
+
+#### `upsert_one`
+Update values of a record in a table. Takes a string as the table name to update a record in, an id of any type, and a `Hash` of values to replace. Returns `Hash`.
+```ruby
+client.upsert_one("test", 1, {name: "test4"})
+# => {"id"=>1, "name"=>"test4", "title"=>"test"}
+```
+
+#### `delete_all`
+Delete all records from a table. Takes a string as the table name to delete records from. Returns `nil`.
+```ruby
+client.delete_all("test")
+# => nil
+```
+
+#### `delete_one`
+Delete a record from a table. Takes a string as the table name to delete a record from, and an id of any type. Returns `nil`.
+```ruby
+client.delete_one("test", 1)
+# => nil
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/surrealdb. 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/[USERNAME]/surrealdb/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Surrealdb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sam-kenney/surrealdb.rb/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "surrealdb"
+
+# 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/lib/surrealdb/clients/http.rb

@@ -0,0 +1,165 @@
+# Copyright © SurrealDB Ltd
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require "httpx"
+require "json"
+
+require_relative "../models/http_response"
+require_relative "../common/surreal_error"
+
+module SurrealDB
+  # HTTP client for SurrealDB.
+  class HTTPClient
+    attr_accessor :url, :namespace, :database, :username, :password
+
+    # @param [String] url The URL of the SurrealDB server.
+    # @param [String] namespace The namespace to use.
+    # @param [String] database The database to use.
+    # @param [String] username The username to authenticate with.
+    # @param [String] password The password to authenticate with.
+    # @return [HTTPClient] The HTTPClient instance.
+    # @yield [HTTPClient] The HTTPClient instance.
+    def initialize(url, namespace:, database:, username:, password:)
+      if url.end_with? "/" then @url = url else @url = "#{url}/" end
+      @namespace = namespace
+      @database = database
+      @username = username
+      @password = password
+
+      @headers = {
+        "NS" => @namespace,
+        "DB" => @database,
+        "Content-Type" => "application/json",
+        "Accept" => "application/json",
+      }
+      yield self if block_given?
+    end
+
+    # Make a request to the SurrealDB server.
+    #
+    # @param [String] method The HTTP method to use.
+    # @param [String] uri The endpoint to request.
+    # @param [Hash | Array<Hash> | nil] data The body of the request.
+    # @return [SurrealDB::HTTPResponse] The response from the server.
+    # @raise [SurrealDB::Exception] If the server returns an error.
+    def _request(method, uri, data = nil)
+      url = @url + uri
+      response = HTTPX.plugin(:basic_authentication)
+                      .basic_authentication(@username, @password)
+                      .with(:headers => @headers)
+                      .request(method, url, :body => data)
+
+      raise SurrealDB::SurrealError.new(
+        response.error.message,
+      ) unless response.error.nil?
+
+      raise SurrealDB::SurrealError.new(
+        response.status,
+        response.json,
+      ) unless (200..300).include?(response.status) and response.json[0]["status"] == "OK"
+
+      SurrealDB::HTTPResponse.from_hash(response.json[0]).result
+    end
+
+    # Execute a query.
+    #
+    # @param [String] query The query to execute.
+    # @return [Array<Hash>] The result of the query.
+    # @raise [SurrealDB::Exception] If the query is invalid.
+    def execute(query)
+      _request("POST", "sql", query)
+    end
+
+    # Insert multiple records into a table.
+    #
+    # @param [String] table The table to insert records into.
+    # @param [Array<Hash>] data The data to insert. Each element
+    #   must be a hash with an "id" key representing a unique identifier.
+    # @raise [SurrealDB::Exception] If there is an issue with the request.
+    def create_all(table, data)
+      _request("POST", "key/#{table}", JSON.generate(data))
+    end
+
+    # Insert a record into a table.
+    #
+    # @param [String] table The table to insert a record into.
+    # @param [String] id The ID of the record to insert.
+    # @param [Hash] data The data to insert.
+    # @return [Hash] The new record.
+    # @raise [SurrealDB::Exception] If there is an issue with the request.
+    def create_one(table, id, data)
+      _request("POST", "key/#{table}/#{id}", JSON.generate(data))[0]
+    end
+
+    # Get all records from a table.
+    #
+    # @param [String] table The table to get records from.
+    # @return [Array<Hash>] The records.
+    # @raise [SurrealDB::Exception] If there is an issue with the request.
+    def select_all(table)
+      _request("GET", "key/#{table}")
+    end
+
+    # Get one record from a table.
+    #
+    # @param [String] table The table to get records from.
+    # @param [String] id The ID of the record to get.
+    # @return [Hash] The record.
+    # @raise [SurrealDB::Exception] If there is an issue with the request.
+    def select_one(table, id)
+      _request("GET", "key/#{table}/#{id}")[0]
+    end
+
+    # Replace a record in a table.
+    #
+    # Requires all fields to be present, and will create
+    # a new record if one with the given ID does not exist.
+    #
+    # @param [String] table The table to replace a record in.
+    # @param [String] id The ID of the record to replace.
+    # @param [Hash] data The data to replace.
+    # @return [Hash] The replaced record.
+    # @raise [SurrealDB::Exception] If there is an issue with the request.
+    def replace_one(table, id, data)
+      _request("PUT", "key/#{table}/#{id}", JSON.generate(data))[0]
+    end
+
+    # Upsert a record in a table.
+    #
+    # Requires only the fields that are being updated.
+    # If a record with the given ID does not exist, it will be created.
+    #
+    # @param [String] table The table to upsert a record in.
+    # @param [String] id The ID of the record to upsert.
+    # @param [Hash] data The data to upsert.
+    # @return [Hash] The upserted record.
+    # @raise [SurrealDB::Exception] If there is an issue with the request.
+    def upsert_one(table, id, data)
+      _request("PATCH", "key/#{table}/#{id}", JSON.generate(data))[0]
+    end
+
+    # Delete all records from a table.
+    #
+    # @param [String] table The table to delete records from.
+    # @raise [SurrealDB::Exception] If there is an issue with the request.
+    def delete_all(table)
+      _request("DELETE", "key/#{table}")
+    end
+
+    # Delete one record from a table.
+    #
+    # @param [String] table The table to delete records from.
+    # @param [String] id The ID of the record to delete.
+    # @raise [SurrealDB::Exception] If there is an issue with the request.
+    def delete_one(table, id)
+      _request("DELETE", "key/#{table}/#{id}")
+    end
+  end
+end

data/lib/surrealdb/common/surreal_error.rb

@@ -0,0 +1,24 @@
+# Copyright © SurrealDB Ltd
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+module SurrealDB
+  class SurrealError < StandardError
+    attr_reader :status, :json
+
+    # @param [Integer] status The HTTP status code.
+    # @param [Hash] json The JSON response.
+    # @return [SurrealDB::SurrealError] The SurrealError instance.
+    def initialize(status, json = nil)
+      @status = status
+      @json = json
+      super("SurrealDB Error: #{status} #{json}")
+    end
+  end
+end

data/lib/surrealdb/models/http_response.rb

@@ -0,0 +1,38 @@
+# Copyright © SurrealDB Ltd
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+module SurrealDB
+  class HTTPResponse
+    attr_reader :time, :status, :result
+
+    # @param [String] time The time taken to execute the request.
+    # @param [Integer] status The HTTP status code.
+    # @param [Hash] result The JSON response.
+    # @return [SurrealDB::HTTPResponse] The HTTPResponse instance.
+    def initialize(time, status, result)
+      @time = time
+      @status = status
+      @result = result
+    end
+
+    # Create a HTTPResponse from a Hash.
+    #
+    # @param [Hash] data The Hash to convert.
+    # @return [SurrealDB::HTTPResponse] The HTTPResponse instance.
+    def self.from_hash(data)
+      HTTPResponse.new data["time"], data["status"], data["result"]
+    end
+
+    # String representation of the HTTPResponse.
+    def to_s
+      "HTTPResponse(time => '#{@time}' status => '#{@status}' result => #{@result})"
+    end
+  end
+end

data/lib/surrealdb/version.rb

@@ -0,0 +1,3 @@
+module Surrealdb
+  VERSION = "0.2.0"
+end

data/lib/surrealdb.rb

@@ -0,0 +1,8 @@
+require "surrealdb/version"
+
+module SurrealDB
+  class Error < StandardError; end
+  # Your code goes here...
+  autoload(:HTTPClient, "surrealdb/clients/http.rb")
+  autoload(:SurrealError, "surrealdb/common/surreal_error.rb")
+end

data/surrealdb.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/surrealdb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "surrealdb"
+  spec.version       = Surrealdb::VERSION
+  spec.authors       = ["Sam Kenney"]
+
+  spec.summary       = "Ruby driver for SurrealDB"
+  spec.homepage      = "https://surrealdb.com/docs/integration/libraries/ruby"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.licenses = ["MIT"]
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sam-kenney/surrealdb.rb/"
+  spec.metadata["changelog_uri"] = "https://github.com/sam-kenney/surrealdb.rb/"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: surrealdb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Sam Kenney
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-23 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/surrealdb.rb
+- lib/surrealdb/clients/http.rb
+- lib/surrealdb/common/surreal_error.rb
+- lib/surrealdb/models/http_response.rb
+- lib/surrealdb/version.rb
+- surrealdb.gemspec
+homepage: https://surrealdb.com/docs/integration/libraries/ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://surrealdb.com/docs/integration/libraries/ruby
+  source_code_uri: https://github.com/sam-kenney/surrealdb.rb/
+  changelog_uri: https://github.com/sam-kenney/surrealdb.rb/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby driver for SurrealDB
+test_files: []