mylk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8cd7535fb4dab7f6534b2c3b12a5e8f1af9884a016fab89c3929e87609f1ca2b
+  data.tar.gz: '0927531fad655748a154d1d04c86423bbf418b69f2e2a78f6638a7eb6a9bd28f'
+SHA512:
+  metadata.gz: f24e7818672c0e1fe84c785d4e60ec9d5da33e7a132ff5bbaac925e51b619fadf9f5f53aa27868ed4c402bcb8f658c2239830eac35426b2feb8224ce728ddd63
+  data.tar.gz: bea072d18f45d0fee689b2ccd02e53295c640063f991c2654d6c74ca69a70f2ddb1974154dbe68303c4b5c2c281f65bdfc3b48c58b26c31c65ba25e74db4c2a4

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## v0.1.2 (2023-02-22)
+
+### Feat
+
+- add type definitions
+
+## v0.1.1 (2023-02-22)
+
+### Fix
+
+- **http**: ensure thread-safety
+
+### Refactor
+
+- rename gem to `surrealdb-client`
+
+## v0.1.0 (2023-02-21)
+
+### Feat
+
+- implement websocket client (#2)
+
+### Refactor
+
+- rename `Websockets` to `Websocket`

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in surrealdb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    mylk (0.1.0)
+      websocket-client-simple (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    event_emitter (0.2.6)
+    json (2.6.1)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbs (2.8.4)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+    websocket (1.2.9)
+    websocket-client-simple (0.6.0)
+      event_emitter
+      websocket
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  mylk!
+  rake (~> 13.0)
+  rbs (~> 2.8)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Rinat Shaykhutdinov
+
+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,69 @@
+# Mylk — The SurrealDB Ruby client
+
+[![Tests](https://github.com/ri-nat/mylk/actions/workflows/main.yml/badge.svg)](https://github.com/ri-nat/mylk/actions/workflows/main.yml)
+
+## Installation
+
+Add gem to the application's Gemfile:
+
+```bash
+gem "mylk"
+```
+
+Install it:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Both the HTTP and WebSocket clients provide the same interface for executing commands. The only difference is the underlying transport mechanism.
+
+If you are building concurrent (multi-threaded) applications, it is recommended to use the WebSocket client due to its superior performance. However, the HTTP client is still thread-safe and can also be used if you prefer.
+
+### WebSocket Client
+
+```ruby
+require "mylk/websocket"
+
+client = Mylk::WebSocket.new("surrealdb://root:root@localhost:8000/test/test").tap(&:connect)
+response = client.execute("INFO FOR DB")
+
+response.success? # => true
+response.time # => "265.625µs"
+response.result # => {"dl"=>{}, "dt"=>{}, "pa"=>{}, "sc"=>{}, "tb"=>{}}
+```
+
+### HTTP Client
+
+```ruby
+require "mylk/http"
+
+client = Mylk::HTTP.new("surrealdb://root:root@localhost:8000/test/test").tap(&:connect)
+response = client.execute("INFO FOR DB")
+
+response.success? # => true
+response.time # => "265.625µs"
+response.result # => {"dl"=>{}, "dt"=>{}, "pa"=>{}, "sc"=>{}, "tb"=>{}}
+```
+
+### Database connection string format
+
+```text
+surreal://<username>:<password>@<host>:<port>/<namespace>/<database>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 the created tag, 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/ri-nat/mylk>.
+
+## 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,16 @@
+# 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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/mylk/base.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Mylk
+  # Base class for SurrealDB clients
+  class Base
+    attr_accessor :uri, :username, :password, :namespace, :database
+
+    # Parameters:
+    #   uri: String
+    #     The URI of the SurrealDB server
+    #     Example: "http://user:password@localhost:8080/namespace/database"
+    def initialize(uri)
+      parse_connection_params(uri)
+    end
+
+    def connect
+      raise NotImplementedError
+    end
+
+    def disconnect
+      raise NotImplementedError
+    end
+
+    def connected?
+      !!@connected
+    end
+
+    def disconnected?
+      !connected?
+    end
+
+    private
+
+    def endpoint_path
+      raise NotImplementedError
+    end
+
+    def endpoint_scheme
+      raise NotImplementedError
+    end
+
+    def parse_connection_params(url) # rubocop:disable Metrics/AbcSize
+      self.uri = URI(url)
+      self.username = uri.user
+      self.password = uri.password
+      self.namespace, self.database = uri.path.split("/")[1..2]
+      uri.path = endpoint_path
+      uri.scheme = endpoint_scheme
+    end
+
+    def format_error(response)
+      json = parse_json_body(response)
+
+      "Query failed with status code #{response.code}\n" \
+        "details: #{json["details"]}\n" \
+        "information: #{json["information"]}\n" \
+        "description: #{json["description"]}"
+    end
+
+    def parse_json_body(response)
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      raise Error, "Invalid JSON response from SurrealDB: #{response.body}"
+    end
+  end
+end

data/lib/mylk/http.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "base64"
+require "net/http"
+require "json"
+
+require_relative "base"
+
+module Mylk
+  # HTTP client for the SurrealDB
+  class HTTP < Base
+    def initialize(url)
+      super
+
+      @connection = Net::HTTP.new(uri.host, uri.port)
+      # Mutex to prevent multiple threads from using the same connection
+      @mutex = Mutex.new
+    end
+
+    def connect
+      return true if connected?
+
+      @mutex.synchronize do
+        @connection.start
+        @connected = true
+      end
+
+      # Ping the server to check if the connection is established
+      execute("INFO FOR DB").success?
+    rescue Error
+      disconnect
+    end
+
+    def disconnect
+      return if disconnected?
+
+      @mutex.synchronize do
+        @connection.finish
+        @connected = false
+      end
+    end
+
+    def execute(query) # rubocop:disable Metrics/AbcSize
+      connect if disconnected?
+
+      request = Net::HTTP::Post.new(uri.path, headers).tap { |r| r.body = query }
+      response = @mutex.synchronize { @connection.request(request) }
+
+      raise Error, format_error(response) unless (200..300).include?(response.code.to_i)
+
+      Response.new(parse_json_body(response).first)
+    end
+
+    private
+
+    def endpoint_path
+      "/sql"
+    end
+
+    def endpoint_scheme
+      "http"
+    end
+
+    def headers
+      @headers ||= {
+        "User-Agent" => "Mylk #{Mylk::VERSION}",
+        "Accept" => "application/json",
+        "Authorization" => "Basic #{Base64.strict_encode64("#{username}:#{password}")}",
+        "Content-Type" => "application/x-www-form-urlencoded",
+        "NS" => namespace,
+        "DB" => database
+      }
+    end
+  end
+end

data/lib/mylk/response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mylk
+  # Response from the SurrealDB
+  class Response
+    attr_reader :result, :status, :time
+
+    def initialize(response)
+      @result = response["result"]
+      @status = response["status"]
+      @time = response["time"]
+    end
+
+    def success?
+      @status == "OK"
+    end
+
+    def error?
+      !success?
+    end
+  end
+end

data/lib/mylk/version.rb

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

data/lib/mylk/websocket.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "websocket-client-simple"
+
+require_relative "base"
+
+module Mylk
+  # WebSocket client for the SurrealDB
+  class WebSocket < Base
+    WAIT_SLEEP_DURATION = 0.001 # 1 millisecond
+    CONNECTION_TIMEOUT = 2 # 2 seconds
+    REQUEST_TIMEOUT = 2 # 2 seconds
+
+    def initialize(url)
+      super
+
+      @connection = nil
+      # Mutex to synchronize the access to the requests hash
+      @mutex = Mutex.new
+      @requests = {}
+    end
+
+    def connect
+      @connection = ::WebSocket::Client::Simple.connect(uri.to_s, headers: headers)
+
+      attach_on_message_handler
+      wait_for_connection_establishment
+
+      @connected = true
+
+      # Authenticate and select the database
+      call_rpc("signin", [{ user: username, pass: password }])
+      call_rpc("use", [namespace, database])
+
+      # Ping the server to check if the connection is established
+      execute("INFO FOR DB").success?
+    end
+
+    def disconnect
+      return if disconnected?
+
+      @connection.close
+      @connected = false
+    end
+
+    def execute(query)
+      Response.new(call_rpc("query", [query]))
+    end
+
+    private
+
+    def call_rpc(method, params)
+      raise Error, "Not connected to SurrealDB" unless connected? || connect
+
+      request_id = SecureRandom.uuid
+      @connection.send({ id: request_id, method: method, params: params }.to_json)
+
+      Timeout.timeout(REQUEST_TIMEOUT) do
+        sleep WAIT_SLEEP_DURATION until @mutex.synchronize { @requests[request_id] }
+      end
+
+      @mutex.synchronize { @requests.delete(request_id) }
+    rescue Timeout::Error
+      raise Error, "Request to SurrealDB timed out"
+    end
+
+    def add_message(parsed)
+      @mutex.synchronize do
+        @requests[parsed["id"]] = parsed["result"].is_a?(Array) ? parsed["result"].first : true
+      end
+    end
+
+    def attach_on_message_handler
+      am = method(:add_message)
+
+      @connection.on :message do |msg|
+        next if msg.data == ""
+
+        am.call(JSON.parse(msg.data))
+      end
+    end
+
+    def wait_for_connection_establishment
+      connected = false
+      @connection.on :open do
+        connected = true
+      end
+
+      # If the connection became opened before the handler was attached, we need to check it
+      connected ||= @connection.open?
+
+      Timeout.timeout(CONNECTION_TIMEOUT) do
+        sleep WAIT_SLEEP_DURATION until connected
+      end
+    rescue Timeout::Error
+      raise Error, "Connection to SurrealDB timed out"
+    end
+
+    def endpoint_path
+      "/rpc"
+    end
+
+    def endpoint_scheme
+      "ws"
+    end
+
+    def headers
+      {
+        "User-Agent" => "Mylk #{Mylk::VERSION}"
+      }
+    end
+  end
+end

data/lib/mylk.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "mylk/response"
+require_relative "mylk/version"
+
+module Mylk
+  class Error < StandardError; end
+end

data/mylk.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/mylk/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mylk"
+  spec.version = Mylk::VERSION
+  spec.authors = ["Rinat Shaykhutdinov"]
+  spec.email = ["mail@rinatshay.com"]
+
+  spec.summary = "SurrealDB client for Ruby (HTTP and WebSocket)"
+  spec.homepage = "https://github.com/ri-nat/mylk"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ri-nat/mylk"
+  spec.metadata["changelog_uri"] = "https://github.com/ri-nat/mylk/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "websocket-client-simple", "~> 0.6"
+
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rbs", "~> 2.8"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+end

data/sig/mylk.rbs

@@ -0,0 +1,31 @@
+module SurrealDB
+  module Client
+    VERSION: String
+
+    class Response
+      attr_reader result: Array[Object]
+      attr_reader status: String
+      attr_reader time: String
+
+      def initialize: (Object) -> void
+      def success?: () -> bool
+      def error?: () -> bool
+    end
+
+    class Base
+      def initialize: (String) -> void
+      def connect: () -> void
+      def disconnect: () -> void
+      def connected?: () -> bool
+      def disconnected?: () -> bool
+    end
+
+    class HTTP < Base
+      def execute: (String) -> Response
+    end
+
+    class WebSocket < Base
+      def execute: (String) -> Response
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: mylk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rinat Shaykhutdinov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description:
+email:
+- mail@rinatshay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mylk.rb
+- lib/mylk/base.rb
+- lib/mylk/http.rb
+- lib/mylk/response.rb
+- lib/mylk/version.rb
+- lib/mylk/websocket.rb
+- mylk.gemspec
+- sig/mylk.rbs
+homepage: https://github.com/ri-nat/mylk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ri-nat/mylk
+  source_code_uri: https://github.com/ri-nat/mylk
+  changelog_uri: https://github.com/ri-nat/mylk/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: SurrealDB client for Ruby (HTTP and WebSocket)
+test_files: []